11## <a name =" CONTRIBUTING " ></a >Contributing
22
33We welcome contributions of all kinds — whether it’s code,
4- documentation, music, lesson plans, artwork, or ideas. Music Blocks
4+ documentation, music, lesson plans, artwork, or ideas. Music Blocks
55is a community-driven project, and every meaningful contribution helps
66improve the platform for learners and educators around the world.
77
88If you’re new to the project, start by setting up the local
9- development environment using the guide linked above , then explore
9+ development environment using the guide linked below , then explore
1010open issues or discussions to find a place to contribute.
1111
1212- [ How to set up a local server] ( README.md#how-to-set-up-a-local-server )
1313
14-
1514### Special Notes
1615
1716Music Blocks is being built from the ground-up, to address several
@@ -50,9 +49,12 @@ following resources:
5049- [ JavaScript tutorial - w3schools.com] ( https://www.w3schools.com/js/default.asp )
5150- [ JavaScript reference - MDN Web Docs] ( https://developer.mozilla.org/en-US/docs/Web/JavaScript )
5251
53- Programmers , please follow these general [ guidelines for
52+ For code contributions , please follow these general [ guidelines for
5453contributions] ( https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md ) .
5554
55+ ### AI guidelines
56+
57+ Follow [ AI guidelines for Sugar Labs] ( https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md#ai-guidelines-for-sugar-labs )
5658
5759### Before You Push
5860
@@ -64,8 +66,20 @@ npx prettier --check . # Formatting
6466npm test # Jest
6567```
6668
69+ NOTE: Only run ``` prettier ``` on the files you have modified.
70+
6771If formatting fails, run ` npx prettier --write . ` to fix it.
6872
73+ ### After your PR is merged
74+
75+ Please note that production deployments of Music Blocks are ** manual** .
76+
77+ This means that even after your pull request is merged, your changes may not immediately appear. Your update will become visible after the next official release is deployed.
78+
79+ If your changes are not visible right away, it does ** not** indicate a problem with your PR or implementation.
80+
81+ This note is included to prevent contributors from spending time debugging caching or deployment issues unnecessarily.
82+
6983### License Header
7084
7185Music Blocks is licensed under the [ AGPL] ( https://www.gnu.org/licenses/agpl-3.0.en.html ) .
@@ -129,60 +143,60 @@ Feel free. But, please don't spam :p.
129143### Keep in Mind
130144
1311451 . Your contributions need not necessarily have to address any
132- discovered issue. If you encounter any, feel free to add a fix through
133- a PR, or create a new issue ticket.
146+ discovered issue. If you encounter any, feel free to add a fix through
147+ a PR, or create a new issue ticket.
134148
1351492 . Use [ labels] ( https://github.com/sugarlabs/musicblocks/labels ) on
136- your issues and PRs.
150+ your issues and PRs.
137151
1381523 . Please do not spam with many PRs consisting of little changes.
139153
1401544 . If you are addressing a bulk change, divide your commits across
141- multiple PRs, and send them one at a time. The fewer the number of
142- files addressed per PR, the better.
155+ multiple PRs, and send them one at a time. The fewer the number of
156+ files addressed per PR, the better.
143157
1441585 . Communicate effectively. Go straight to the point. You don't need
145- to address anyone using '_ sir_ '. Don't write unnecessary comments;
146- don't be over-apologetic. There is no superiority hierarchy. Every
147- single contribution is welcome, as long as it doesn't spam or distract
148- the flow.
159+ to address anyone using '_ sir_ '. Don't write unnecessary comments;
160+ don't be over-apologetic. There is no superiority hierarchy. Every
161+ single contribution is welcome, as long as it doesn't spam or distract
162+ the flow.
149163
1501646 . Write useful, brief commit messages. Add commit descriptions if
151- necessary. PR name should speak about what it is addressing and not
152- the issue. In case a PR fixes an issue, use ` fixes #ticketno ` or
153- ` closes #ticketno ` in the PR's comment. Briefly explain what your PR
154- is doing.
165+ necessary. PR name should speak about what it is addressing and not
166+ the issue. In case a PR fixes an issue, use ` fixes #ticketno ` or
167+ ` closes #ticketno ` in the PR's comment. Briefly explain what your PR
168+ is doing.
155169
1561707 . Always test your changes extensively before creating a PR. There's
157- no sense in merging broken code. If a PR is a _ work in progress
158- (WIP)_ , convert it to draft. It'll let the maintainers know it isn't
159- ready for merging.
171+ no sense in merging broken code. If a PR is a _ work in progress
172+ (WIP)_ , convert it to draft. It'll let the maintainers know it isn't
173+ ready for merging.
160174
1611758 . Read and revise the concepts about programming constructs you're
162- dealing with. You must be clear about the behavior of the language or
163- compiler/transpiler. See [ JavaScript
164- docs] ( https://developer.mozilla.org/en-US/docs/Web/JavaScript ) .
176+ dealing with. You must be clear about the behavior of the language or
177+ compiler/transpiler. See [ JavaScript
178+ docs] ( https://developer.mozilla.org/en-US/docs/Web/JavaScript ) .
165179
1661809 . If you have a question, do a _ web search_ first. If you don't find
167- any satisfactory answer, then ask it in a comment. If it is a general
168- question about Music Blocks, please use the new
169- [ discussions] ( https://github.com/sugarlabs/musicblocks/discussions )
170- tab on top the the repository, or the _ Sugar-dev Devel
171- <[ sugar-devel@lists.sugarlabs.org ] ( mailto:sugar-devel@lists.sugarlabs.org ) >_
172- mailing list. Don't ask silly questions (unless you don't know it is
173- silly ;p) before searching it on the web.
181+ any satisfactory answer, then ask it in a comment. If it is a general
182+ question about Music Blocks, please use the new
183+ [ discussions] ( https://github.com/sugarlabs/musicblocks/discussions )
184+ tab on top the the repository, or the _ Sugar-dev Devel
185+ <[ sugar-devel@lists.sugarlabs.org ] ( mailto:sugar-devel@lists.sugarlabs.org ) >_
186+ mailing list. Don't ask silly questions (unless you don't know it is
187+ silly ;p) before searching it on the web.
174188
17518910 . Work on things that matter. Follow three milestones: ` Port Ready ` ,
176- ` Migration ` , and ` Future ` . Those tagged ` Port Ready ` are
177- priority. Those tagged with ` Migration ` will be taken care of during
178- or after the foundation rebuild. Feel free to participate in the
179- conversation, adding valuable comments. Those tagged with ` Future `
180- need not be addressed presently.
190+ ` Migration ` , and ` Future ` . Those tagged ` Port Ready ` are
191+ priority. Those tagged with ` Migration ` will be taken care of during
192+ or after the foundation rebuild. Feel free to participate in the
193+ conversation, adding valuable comments. Those tagged with ` Future `
194+ need not be addressed presently.
181195
182196_ Please note there is no need to ask permission to work on an
183197issue. You should check for pull requests linked to an issue you are
184198addressing; if there are none, then assume nobody has done
185199anything. Begin to fix the problem, test, make your commits, push your
186200commits, then make a pull request. Mention an issue number in the pull
187201request, but not the commit message. These practices allow the
188- competition of ideas (Sugar Labs is a meritocracy)._
202+ competition of ideas (Sugar Labs is a meritocracy)._
0 commit comments