Merge pull request #494 from MisRob/docs-updates

Update contributing guidelines + improve changelog sections structure

CHANGELOG.md

@@ -4,8 +4,16 @@ Changelog is rather internal in nature. See release notes for the public overvie
 
 ## Upcoming version
 
+- [#494]
+  - **Description:** Update contributing guidelines
+  - **Products impact:** none
+  - **Addresses:** -
+  - **Components:** -
+  - **Breaking:** -
+  - **Impacts a11y:** -
+  - **Guidance:** -
 
-## Version 2.0.0
+[#494]: [https://github.com/learningequality/kolibri-design-system/pull/494]
 
 - [#492]
   - **Description:** Add autofocus directive on KRadioButton to fix autofocus behavior on dynamic rendering.
@@ -24,7 +32,7 @@ Changelog is rather internal in nature. See release notes for the public overvie
   - **Addresses:** -
   - **Components:** KDropdownMenu
   - **Breaking:** No
-  - **Impacts a11y:** Does this change improve a11y or adds new features that can be used to improve it? Choose from: yes / no
+  - **Impacts a11y:** yes
   - **Guidance:**  The @tab event can be used for more precise focus management as the popover by default could end up sending focus to the root HTML element by default. Note that the browser event is passed to the handler function, so you may need/want to call `preventDefault()` on that event depending on your use case.
 
   [#497]: https://github.com/learningequality/kolibri-design-system/pull/497

CONTRIBUTING.md

@@ -1,17 +1,27 @@
 <!-- Also update README.md (duplicate) -->
+## How can I contribute?
 
-# How can I contribute?
-
-1. 💻 Follow the [Getting started](./dev_docs/01_getting_started.md) to set up your development server. At the bottom of that page, you will also find links that will take you to guidelines for the most common tasks.
-2. 🔍 Search for issues tagged as [help wanted](https://github.com/learningequality/kolibri-design-system/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee+) or [good first issue](https://github.com/learningequality/kolibri-design-system/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee).
-3. 🗣️ 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 Design System GitHub Discussions](https://github.com/learningequality/kolibri-design-system/discussions).
+1. 💻 **Follow the [Getting started](./dev_docs/01_getting_started.md) to set up your development server.** At the bottom of the page, you can also find links that will take you to guidelines for the most common tasks.
+2. 🔍 **Search for issues tagged as [help wanted](https://github.com/learningequality/kolibri-design-system/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee+) or [good first issue](https://github.com/learningequality/kolibri-design-system/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 [developer documentation](./dev_docs/) at first. Some answers may already be there.
+- For anything development related, refer to the [Developer documentation](./dev_docs/) 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 Design System GitHub Discussions](https://github.com/learningequality/kolibri-design-system/discussions) to ask about anything related to contributing to Kolibri Design System, troubleshoot development server issues, or connect with other contributors.
+- Visit [GitHub Discussions](https://github.com/learningequality/kolibri-design-system/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-design-system/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-design-system/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 Design System! The Kolibri 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.*

README.md

@@ -45,16 +45,27 @@ If you have found a bug, you can create a [Github issue](https://github.com/lear
 <!-- Also update README.md (duplicate) -->
 ## How can I contribute?
 
-1. 💻 Follow the [Getting started](./dev_docs/01_getting_started.md) to set up your development server. At the bottom of that page, you will also find links that will take you to guidelines for the most common tasks.
-2. 🔍 Search for issues tagged as [help wanted](https://github.com/learningequality/kolibri-design-system/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee+) or [good first issue](https://github.com/learningequality/kolibri-design-system/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee).
-3. 🗣️ 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 Design System GitHub Discussions](https://github.com/learningequality/kolibri-design-system/discussions).
+1. 💻 **Follow the [Getting started](./dev_docs/01_getting_started.md) to set up your development server.** At the bottom of the page, you can also find links that will take you to guidelines for the most common tasks.
+2. 🔍 **Search for issues tagged as [help wanted](https://github.com/learningequality/kolibri-design-system/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee+) or [good first issue](https://github.com/learningequality/kolibri-design-system/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 [developer documentation](./dev_docs/) at first. Some answers may already be there.
+- For anything development related, refer to the [Developer documentation](./dev_docs/) 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 Design System GitHub Discussions](https://github.com/learningequality/kolibri-design-system/discussions) to ask about anything related to contributing to Kolibri Design System, troubleshoot development server issues, or connect with other contributors.
+- Visit [GitHub Discussions](https://github.com/learningequality/kolibri-design-system/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-design-system/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-design-system/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 Design System! The Kolibri 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.*