forked from learningequality/kolibri
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Suggest contributors ask for a reasonable amount of issues - Add a note on our response times - Add "How to connect section" - Remove "Kolibri" when possible so that guidelines can be copied/pasted more easily accross other repositories - Mark important point in bold - Minor wording tweaks
- Loading branch information
Showing
2 changed files
with
41 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,28 @@ | ||
|
|
||
| <!-- Also update README.md (duplicate) --> | ||
| ## How can I contribute? | ||
|
|
||
| # How can I contribute? | ||
|
|
||
| 1. 📙 Skim through the [Kolibri developer documentation](https://kolibri-dev.readthedocs.io) to understand where to refer later on. | ||
| 2. 💻 Follow [Getting started](https://kolibri-dev.readthedocs.io/en/develop/getting_started.html) to set up your development server. Some of the [How To Guides](https://kolibri-dev.readthedocs.io/en/develop/howtos/index.html#howtos) may be handy too. | ||
| 3. 🔍 Search for issues tagged as [help wanted](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee) or [good first issue](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee). | ||
| 4. 🗣️ Ask us for an assignment in the comments of an issue you've chosen. | ||
|
|
||
| Note that in times of increased contributions activity, it may take us a few days to reply. If you don't hear from us within a week, please reach out via [Kolibri GitHub Discussions](https://github.com/learningequality/kolibri/discussions). | ||
| 1. 📙 **Skim through the [Developer documentation](https://kolibri-dev.readthedocs.io)** to understand where to refer later on. | ||
| 2. 💻 **Follow the [Getting started](https://kolibri-dev.readthedocs.io/en/develop/getting_started.html) to set up your development server.** Some of the [How To Guides](https://kolibri-dev.readthedocs.io/en/develop/howtos/index.html#howtos) may be handy too. | ||
| 3. 🔍 **Search for issues tagged as [help wanted](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee) or [good first issue](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee).** | ||
| 4. 🗣️ **Ask us for an assignment in the comments of an issue you've chosen.** Please request assignment of a reasonable amount of issues at a time. Once you finish your current issue or two, you are welcome to ask for more. | ||
|
|
||
| **❓ Where to ask questions** | ||
|
|
||
| - For anything development related, refer to the [Kolibri developer documentation](https://kolibri-dev.readthedocs.io) at first. Some answers may already be there. | ||
| - For anything development related, refer to the [Developer documentation](https://kolibri-dev.readthedocs.io) at first. Some answers may already be there. | ||
| - For questions related to a specific issue or assignment requests, use the corresponding issue's comments section. | ||
| - Visit [Kolibri GitHub Discussions](https://github.com/learningequality/kolibri/discussions) to ask about anything related to contributing to Kolibri, troubleshoot development server issues, or connect with other contributors. | ||
| - Visit [GitHub Discussions](https://github.com/learningequality/kolibri/discussions) to ask about anything related to contributing or to troubleshoot development server issues. | ||
|
|
||
| **👥 How to connect** | ||
|
|
||
| - We encourage you to visit [GitHub Discussions](https://github.com/learningequality/kolibri/discussions) to connect with the Learning Equality team as well as with other contributors. | ||
| - If you'd like to contribute on a regular basis, we are happy to invite you to our open-source community Slack channel. Get in touch with us at [email protected] to receive an invitation. | ||
|
|
||
| --- | ||
|
|
||
| 🕖 Please allow us a few days to reply to your comments. If you don't hear from us within a week, reach out via [GitHub Discussions](https://github.com/learningequality/kolibri/discussions). | ||
|
|
||
| As soon as you open a pull request, it may take us a week or two to review it as we're a small team. We appreciate your contribution and will provide feedback. | ||
|
|
||
| --- | ||
|
|
||
| *Thank you for your interest in contributing to Kolibri! The project was founded by volunteers dedicated to helping make educational materials more accessible to those in need, and every contribution makes a difference.* | ||
| *Thank you for your interest in contributing! Learning Equality was founded by volunteers dedicated to helping make educational materials more accessible to those in need, and every contribution makes a difference.* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,17 +33,28 @@ If you have found a bug and are comfortable using Github and Markdown, you can c | |
| <!-- Also update CONTRIBUTING.md (duplicate) --> | ||
| ## How can I contribute? | ||
|
|
||
| 1. 📙 Skim through the [Kolibri developer documentation](https://kolibri-dev.readthedocs.io) to understand where to refer later on. | ||
| 2. 💻 Follow [Getting started](https://kolibri-dev.readthedocs.io/en/develop/getting_started.html) to set up your development server. Some of the [How To Guides](https://kolibri-dev.readthedocs.io/en/develop/howtos/index.html#howtos) may be handy too. | ||
| 3. 🔍 Search for issues tagged as [help wanted](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee) or [good first issue](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee). | ||
| 4. 🗣️ Ask us for an assignment in the comments of an issue you've chosen. | ||
|
|
||
| Note that in times of increased contributions activity, it may take us a few days to reply. If you don't hear from us within a week, please reach out via [Kolibri GitHub Discussions](https://github.com/learningequality/kolibri/discussions). | ||
| 1. 📙 **Skim through the [Developer documentation](https://kolibri-dev.readthedocs.io)** to understand where to refer later on. | ||
| 2. 💻 **Follow the [Getting started](https://kolibri-dev.readthedocs.io/en/develop/getting_started.html) to set up your development server.** Some of the [How To Guides](https://kolibri-dev.readthedocs.io/en/develop/howtos/index.html#howtos) may be handy too. | ||
| 3. 🔍 **Search for issues tagged as [help wanted](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee) or [good first issue](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee).** | ||
| 4. 🗣️ **Ask us for an assignment in the comments of an issue you've chosen.** Please request assignment of a reasonable amount of issues at a time. Once you finish your current issue or two, you are welcome to ask for more. | ||
|
|
||
| **❓ Where to ask questions** | ||
|
|
||
| - For anything development related, refer to the [Kolibri developer documentation](https://kolibri-dev.readthedocs.io) at first. Some answers may already be there. | ||
| - For anything development related, refer to the [Developer documentation](https://kolibri-dev.readthedocs.io) at first. Some answers may already be there. | ||
| - For questions related to a specific issue or assignment requests, use the corresponding issue's comments section. | ||
| - Visit [Kolibri GitHub Discussions](https://github.com/learningequality/kolibri/discussions) to ask about anything related to contributing to Kolibri, troubleshoot development server issues, or connect with other contributors. | ||
| - Visit [GitHub Discussions](https://github.com/learningequality/kolibri/discussions) to ask about anything related to contributing or to troubleshoot development server issues. | ||
|
|
||
| **👥 How to connect** | ||
|
|
||
| - We encourage you to visit [GitHub Discussions](https://github.com/learningequality/kolibri/discussions) to connect with the Learning Equality team as well as with other contributors. | ||
| - If you'd like to contribute on a regular basis, we are happy to invite you to our open-source community Slack channel. Get in touch with us at [email protected] to receive an invitation. | ||
|
|
||
| --- | ||
|
|
||
| 🕖 Please allow us a few days to reply to your comments. If you don't hear from us within a week, reach out via [GitHub Discussions](https://github.com/learningequality/kolibri/discussions). | ||
|
|
||
| As soon as you open a pull request, it may take us a week or two to review it as we're a small team. We appreciate your contribution and will provide feedback. | ||
|
|
||
| --- | ||
|
|
||
| *Thank you for your interest in contributing to Kolibri! The project was founded by volunteers dedicated to helping make educational materials more accessible to those in need, and every contribution makes a difference.* | ||
| *Thank you for your interest in contributing! Learning Equality was founded by volunteers dedicated to helping make educational materials more accessible to those in need, and every contribution makes a difference.* | ||