Contribution Guide¶

We're excited to have you here! Your interest in contributing to SceneryStack is very welcome and quite appreciated. Please read the following carefully, according to how you'd like to contribute to the community. Make sure your participation aligns with the Code of Conduct.

How Can I Contribute?¶

0. Contributing to Open-Source Projects¶

Never participated in an open-source project? Just ask in any of our community platforms!

You'll find some good general advice in resources such as this article from FreeCodeCamp.

1. Code Contributions (Bug Fixes, Features, etc.)¶

Our ecosystem comprises various common code libraries, each housed in their respective repositories under phetsims. Some libraries depend on others; for instance, Sun is built upon Scenery to design UI components.

👉 If you're considering making an addition or a fix that isn't already documented, initiate by opening an issue and getting community feedback.

Get started with code contributions by following the steps outlined below.

2. Documentation Enhancements¶

We welcome improvements to our documentation, including in the website repository scenerystack/community. This includes:

• Adding new tutorial documentation, API documentation for any library, library READMEs, and more
• Refine or correct existing documentation
• Providing translations to existing documentation

3. Partnerships or Finanacial Contributions¶

Got a unique idea or suggestion? Interested in partnering with SceneryStack? We're all ears!

• Reach out to us on the Discussions forum or chat platforms.

Individuals or groups interested in making a financial contribution can do so at our SceneryStack Network For Good page, every bit helps!

Steps for Code Contribution¶

Contributing is streamlined with the following steps:

1. Make an Issue and Review Contribution Guidelines¶

1. Start by raising an issue using the provided BUG_REPORT_TEMPLATE or FEATURE_REQUEST_TEMPLATE in the appropriate repository.
2. Unsure about the right repository? Ask on the Discussion forum.
3. Familiarize yourself with the standard CODE_OF_CONDUCT.
4. Don't forget to sign the Contributor License Agreement before diving in.

2. Checkout SceneryStack and Make Changes¶

1. Get the latest code for SceneryStack and checkout each SceneryStack repository (See Modifying SceneryStack for more details or for checking out specific versions:

   npx scenerystack checkout
   

2. Make your changes in the appropriate repository.
3. Ensure that your changes are in sync with the latest changes in the main branch.
4. Run tests to ensure that your changes don't break anything, include any testing you did in the PR description.
5. Update the documentation if necessary (fork scenerystack/community and make changes there, submit pull request as outlined below).
6. Make sure your code is well-documented and follows the code style guide.

3. Submit a Pull Request¶

1. Fork the repository on GitHub:
   • Go to the original repository on GitHub.
   • Click the "Fork" button at the top right of the page.
   • This will create a copy of the repository under your GitHub account.

1. Add your fork as a remote:

   • Open your terminal and navigate to the local clone of the repository.
   • Add your fork as a new remote:

     git remote add fork https://github.com/<your-username>/<forked-repo>.git
     

2. Push your local changes to your fork:

   • Push your local branch to your fork:

     git push fork <branch-name>
     

3. Create a pull request:

   • Go to your forked repository on GitHub.
   • You should see a prompt to create a pull request for the recently pushed branch.
   • Click "Compare & pull request".
   • Fill out the pull request form with a descriptive title and detailed description of your change using the provided PULL_REQUEST_TEMPLATE.
   • Submit the pull request.

4. Respond to feedback:

   • A maintainer will review your pull request and may provide feedback.

   • Make any necessary changes and push them to your fork:

     git push fork <branch-name>
     

   • Due to the evolving nature of SceneryStack APIs, double check that your PR changes are still in sync with the latest changes.

5. Merge the pull request:

   • Once your pull request is approved, it will be merged into the main branch of the original repository and your changes will be included in the next release of SceneryStack.

Replace <your-username> with your GitHub username and <forked-repo> with the name of the forked repository. Replace <branch-name> with the name of the branch you are working on.

Celebrate your contribution and post about it on the Discussions forum!

If you're interested in contributing further, check out the open issues.

Questions? Get in Touch¶

Connect with our community on the Discussions forum or through Slack/Matrix.