diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a93bfcdca1b2e8..dc459660746d10 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -32,7 +32,7 @@ The next most important script runs all the appropriate testing. The E-2-E testi npm test -The linting is there to keep a consistent code-style across the all of the code and the testing is there to help catch bugs and check that the code behaves as expected. It is important that neither of these steps comes up with any errors due to your changes. +The linting is there to keep a consistent code style across all of the code and the testing is there to help catch bugs and check that the code behaves as expected. It is important that neither of these steps comes up with any errors due to your changes. Many linting errors can be fixed automatically by running @@ -63,20 +63,20 @@ When you’ve decided to make changes, start with the following: ## Important notes: -* Don't include any build files to your commit. +* Don't include any build files in your commit. * Not all new features will need a new example. Simpler features could be incorporated into an existing example. Bigger features may be asked to add an example demonstrating the feature. * Making changes may require changes to the documentation. To update the docs in other languages, simply copy the English to begin with. * it's good to also add an example and screenshot for it, for showing how it's used and for end-to-end testing. * If you modify existing code, run relevant examples to check they didn't break and there wasn't performance regress. * If you add some assets for the examples (models, textures, sounds, etc), make sure they have a proper license allowing for their use here, less restrictive the better. It is unlikely for large assets to be accepted. -* If some issue is relevant to patch / feature, please mention it with hash (e.g. #2774) in a commit message to get cross-reference in GitHub. +* If some issue is relevant to the patch/feature, please mention it with a hash (e.g. #2774) in a commit message to get cross-reference in GitHub. * If you modify files in `examples/jsm` directory, then don't perform any changes in the `examples/js`, non-module files are auto-generated by running `npm run build-examples`. -* If end-to-end test failed in Travis and you are sure that all is correct, make a new screenshots with +* If the end-to-end test failed in Travis and you are sure that all is correct, make a new screenshot with npm run make-screenshot ... -* Once done with a patch / feature do not add more commits to a feature branch +* Once done with a patch/feature do not add more commits to a feature branch * Create separate branches per patch or feature. * If you make a PR but it is not actually ready to be pulled into the dev branch then please [convert it to a draft PR](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft). -This project is currently contributed to mostly via everyone's spare time. Please keep that in mind as it may take some time for the appropriate feedback to get to you. If you are unsure about adding a new feature, it might be better to ask first to see whether other people think it's a good idea. +This project is currently contributed mostly via everyone's spare time. Please keep that in mind as it may take some time for the appropriate feedback to get to you. If you are unsure about adding a new feature, it might be better to ask first to see whether other people think it's a good idea.