docs: improve contributing documentation & developer workflow #744
Conversation
This file contains hidden or 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
🎉 All Checks Passed!
✅ Completed Workflows
🚀 This PR is ready for review and can be safely merged to Great work! Your code meets all quality standards. 👏 |
Contributor
|
alright. So in the contribution guide doc. Add a new section at the very bottom. "Step by step on how to run and contribute", something like this. Just do how you like it, but keep it accurate and correct, and it should be at the bottom. |
Contributor
Author
|
Sounds good, will do this👍🏻 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 PR aims to improve the
CONTRIBUTING.mddocumentation (and potentially related docs) to make it easier for new contributors to understand Sugar Labs, run the project locally, and follow the recommended linting and formatting workflows, etc. The goal is to make the contribution process clearer, more efficient, and easier to follow.Context
This change is based on maintainer feedback in the discussion #742 , where improving documentation and contributor workflows was suggested.
This PR is opened as a draft since the content will be refined further for better clarity and correctness.
Notes
This is an initial draft. I’ll start working on the documentation updates shortly and will share progress and details about the changes as they are implemented.