Update contributing guidelines + improve changelog sections structure #494
Conversation
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
- Suggest contributors ask for a reasonable amount of issues - Add a note on our response times - Add "How to connect section" - Remove "Kolibri Design System" when possible so that guidelines can be copied/pasted more easily accross other repositories - Mark important points in bold - Minor wording tweaks
MisRob
changed the title
MisRob
changed the title
to align it with the current process of updating the changelog
|
@thanksameeelian Feedback and conflicts resolved |
|
Alright, fixed again. I tried my best to double-check so hopefully it's okay now. Thank you for paying attention, @thanksameeelian |
thanksameeelian
approved these changes
Nov 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is a sibling to learningequality/kolibri#11560. I only copied the latest Kolibri CONTRIBUTING.md (including its copy in README.md) from that Kolibri's #11560 and updated a few links to point to KDS places when relevant.
In addition, it also removes two "active" sections from the changelog in favor of keeping only "Upcoming release" to make updating the changelog smoother for everyone. We will create v2.0.0 section after the final release and split the changelog items accordingly, not before. cc @thanksameeelian @marcellamaki
Changelog
Steps to test
I think that reviewing learningequality/kolibri#11560 is sufficient. You could also test that KDS links are working well.
Testing checklist
If there are any front-end changes, before/after screenshots are includedCritical and brittle code paths are covered by unit testsReviewer guidance
Is the code clean and well-commented?Are there tests for this change?Are all UI components LTR and RTL compliant (if applicable)?After review
CHANGELOG.md