Przeglądaj źródła

Shorten and move contributing sections from #8160

- Want the readme contributing section to be short to encourage
contributors to read CONTRIBUTING.md
- Emphasize non-coding ways to help as we could use help there
- Moved good first issues and dev links to CONTRIBUTING.md
Gabriel Horner 2 lat temu
rodzic
commit
b68ae17ab6
2 zmienionych plików z 23 dodań i 17 usunięć
  1. 19 4
      CONTRIBUTING.md
  2. 4 13
      README.md

+ 19 - 4
CONTRIBUTING.md

@@ -20,14 +20,28 @@ Please read and follow our [Code of Conduct][coc].
 
 ## <a name="how-can-i-help"></a> How can I help?
 
-There are many ways you can help:
+There are many ways you can help. Here are some ways to help without coding:
 
 - You can be help others on [Discord][discord] or [Reddit](https://www.reddit.com/r/logseq).
 - You can [contribute to the official docs](https://github.com/logseq/docs/blob/master/CONTRIBUTING.md).
 - You can confirm bugs on the [issue tracker][issue-tracker] and mention reproducible steps. It helps the core team to get more reports so we can fix the highest priority bugs.
 - You can contribute [translations][translations] with a [pull request](#submit-pr).
-- You can contribute code with a [pull request](#submit-pr). See [our Project board](https://github.com/orgs/logseq/projects/5/views/1?pane=info) and [good first issues](https://github.com/logseq/logseq/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) for ideas.
-- You can extend Logseq with [plugins](https://docs.logseq.com/#/page/Plugins) to share functionality that our community can benefit from.
+
+For ways to help with coding, read the next section.
+
+### <a name="code-contributions"></a> Code Contributions
+
+For contributors who want to help with coding, we have a list of [good first
+issues](https://github.com/logseq/logseq/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
+to help you get started. These are issues that are beginner-friendly and do not
+require advanced knowledge of the codebase. We encourage new contributors to
+start with these issues and gradually work their way up to more challenging
+tasks. We also have a project board to keep track of community contributions
+[Logseq - Develop Together
+💪](https://github.com/orgs/logseq/projects/5?query=is%3Aopen+sort%3Aupdated-desc).
+Another way to help with coding is by extending Logseq with
+[plugins](https://docs.logseq.com/#/page/Plugins) and submit them to the [marketplace](https://github.com/logseq/marketplace) so that the
+whole community can benefit.
 
 ## <a name="question"></a> Got a Question or a Problem?
 
@@ -124,7 +138,8 @@ When submitting a Pull Request (PR) or expecting a subsequent review, please fol
 
 * To run Logseq locally, see [this doc](https://github.com/logseq/logseq/blob/master/docs/develop-logseq.md) or [this doc for windows](https://github.com/logseq/logseq/blob/master/docs/develop-logseq-on-windows.md).
 * To contribute to translations, please read our [translation contribution guidelines][translations].
-* See [this doc](https://github.com/logseq/logseq/blob/master/docs/dev-practices.md) to understand best practices on this project.
+* See [our development practices doc](https://github.com/logseq/logseq/blob/master/docs/dev-practices.md) to learn how we develop.
+* See [the overview doc](CODEBASE_OVERVIEW.md) to get an overview of the codebase.
 
 ### <a name="cla"></a> Sign the CLA
 

+ 4 - 13
README.md

@@ -62,7 +62,6 @@
   * [<g-emoji class="g-emoji" alias="electric_plug" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png">🔌</g-emoji> Plugin API](#-plugin-api)
   * [<g-emoji class="g-emoji" alias="star2" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png">🌟</g-emoji> Contributing to Logseq](#-contributing-to-logseq)
     * [<g-emoji class="g-emoji" alias="hammer_and_wrench" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png">🛠️</g-emoji> Setting Up a Development Environment](#️-setting-up-a-development-environment)
-    * [<g-emoji class="g-emoji" alias="mortar_board" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f393.png">🎓</g-emoji> Good First Issues](#-good-first-issues)
   * [<g-emoji class="g-emoji" alias="sparkles" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/2728.png">✨</g-emoji> Inspiration](#-inspiration)
 * [<g-emoji class="g-emoji" alias="pray" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png">🙏</g-emoji> Thank You](#-thank-you)
 
@@ -127,11 +126,10 @@ Thank you for using Logseq, and we look forward to seeing what you create with o
 
 ## 🌟 Contributing to Logseq
 
-To start contributing to Logseq, please follow the guidelines outlined in [CONTRIBUTING.md](CONTRIBUTING.md). We have a dedicated [overview page](CODEBASE_OVERVIEW.md) for Logseq's codebase and a [development practices guide](docs/dev-practices.md) that provides detailed information on our development process.
-
-We welcome all contributions, big or small, and we appreciate your time and effort in helping us improve Logseq.
-
-We look forward to your contributions 🚀
+To start contributing to Logseq, please read [CONTRIBUTING.md](CONTRIBUTING.md).
+There are ways to contribute [with code](https://github.com/logseq/logseq/blob/master/CONTRIBUTING.md#code-contributions) and [without code](https://github.com/logseq/logseq/blob/master/CONTRIBUTING.md#-how-can-i-help). We welcome all
+contributions, big or small, and we appreciate your time and effort in helping
+us improve Logseq. We look forward to your contributions 🚀
 
 ### 🛠️ Setting Up a Development Environment
 
@@ -139,13 +137,6 @@ If you want to set up a development environment for the Logseq web or desktop ap
 
 In addition to these guides, you can also find other helpful resources in the [docs/](docs/) folder, such as the [Guide for Contributing to Translations](docs/contributing-to-translations.md), the [Docker Web App Guide](docs/docker-web-app-guide.md) and the [mobile development guide](docs/develop-logseq-on-mobile.md)
 
-### 🎓 Good First Issues
-
-We have compiled a list of [good first issues](https://github.com/logseq/logseq/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) to help you get started. These are issues that are beginner-friendly and do not require advanced knowledge of the codebase. We encourage new contributors to start with these issues and gradually work their way up to more challenging tasks.
-We also have a project board to keep track of community contributions [Logseq - Develop Together 💪](https://github.com/orgs/logseq/projects/5?query=is%3Aopen+sort%3Aupdated-desc).
-
-Thank you for considering contributing to Logseq!
-
 ## ✨ Inspiration
 
 Logseq is inspired by several unique tools and projects, including [Roam Research](https://roamresearch.com/), [Org Mode](https://orgmode.org/), [TiddlyWiki](https://tiddlywiki.com/), [Workflowy](https://workflowy.com/), and [Cuekeeper](https://github.com/talex5/cuekeeper).