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
@@ -11,7 +11,6 @@ open 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
@@ -53,7 +52,6 @@ following resources:
5352Programmers, please follow these general [ guidelines for
5453contributions] ( https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md ) .
5554
56-
5755### Before You Push
5856
5957Run these commands locally before submitting a PR:
@@ -64,8 +62,20 @@ npx prettier --check . # Formatting
6462npm test # Jest
6563```
6664
65+ NOTE: Only run ``` prettier ``` on the files you have modified.
66+
6767If formatting fails, run ` npx prettier --write . ` to fix it.
6868
69+ ### After your PR is merged
70+
71+ Please note that production deployments of Music Blocks are ** manual** .
72+
73+ 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.
74+
75+ If your changes are not visible right away, it does ** not** indicate a problem with your PR or implementation.
76+
77+ This note is included to prevent contributors from spending time debugging caching or deployment issues unnecessarily.
78+
6979### License Header
7080
7181Music Blocks is licensed under the [ AGPL] ( https://www.gnu.org/licenses/agpl-3.0.en.html ) .
@@ -129,60 +139,60 @@ Feel free. But, please don't spam :p.
129139### Keep in Mind
130140
1311411 . 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.
142+ discovered issue. If you encounter any, feel free to add a fix through
143+ a PR, or create a new issue ticket.
134144
1351452 . Use [ labels] ( https://github.com/sugarlabs/musicblocks/labels ) on
136- your issues and PRs.
146+ your issues and PRs.
137147
1381483 . Please do not spam with many PRs consisting of little changes.
139149
1401504 . 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.
151+ multiple PRs, and send them one at a time. The fewer the number of
152+ files addressed per PR, the better.
143153
1441545 . 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.
155+ to address anyone using '_ sir_ '. Don't write unnecessary comments;
156+ don't be over-apologetic. There is no superiority hierarchy. Every
157+ single contribution is welcome, as long as it doesn't spam or distract
158+ the flow.
149159
1501606 . 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.
161+ necessary. PR name should speak about what it is addressing and not
162+ the issue. In case a PR fixes an issue, use ` fixes #ticketno ` or
163+ ` closes #ticketno ` in the PR's comment. Briefly explain what your PR
164+ is doing.
155165
1561667 . 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.
167+ no sense in merging broken code. If a PR is a _ work in progress
168+ (WIP)_ , convert it to draft. It'll let the maintainers know it isn't
169+ ready for merging.
160170
1611718 . 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 ) .
172+ dealing with. You must be clear about the behavior of the language or
173+ compiler/transpiler. See [ JavaScript
174+ docs] ( https://developer.mozilla.org/en-US/docs/Web/JavaScript ) .
165175
1661769 . 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.
177+ any satisfactory answer, then ask it in a comment. If it is a general
178+ question about Music Blocks, please use the new
179+ [ discussions] ( https://github.com/sugarlabs/musicblocks/discussions )
180+ tab on top the the repository, or the _ Sugar-dev Devel
181+ <[ sugar-devel@lists.sugarlabs.org ] ( mailto:sugar-devel@lists.sugarlabs.org ) >_
182+ mailing list. Don't ask silly questions (unless you don't know it is
183+ silly ;p) before searching it on the web.
174184
17518510 . 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.
186+ ` Migration ` , and ` Future ` . Those tagged ` Port Ready ` are
187+ priority. Those tagged with ` Migration ` will be taken care of during
188+ or after the foundation rebuild. Feel free to participate in the
189+ conversation, adding valuable comments. Those tagged with ` Future `
190+ need not be addressed presently.
181191
182192_ Please note there is no need to ask permission to work on an
183193issue. You should check for pull requests linked to an issue you are
184194addressing; if there are none, then assume nobody has done
185195anything. Begin to fix the problem, test, make your commits, push your
186196commits, then make a pull request. Mention an issue number in the pull
187197request, but not the commit message. These practices allow the
188- competition of ideas (Sugar Labs is a meritocracy)._
198+ competition of ideas (Sugar Labs is a meritocracy)._
0 commit comments