Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

28 lines (18 loc) · 2.89 KB
Raw

Contributing guidelines

For anyone who knows JavaScript basics: feel free to contribute to this repository! Our code is open source. Be sure to follow our code of conduct.

Filing issues

Found a bug? Report it in an issue! But first, be sure to check if it was already reported by using the search bar here. If there are no similar issues, you can create a new one. We will take a look at it.

Also, feel free to ask questions, suggest new features, and more.

Another way to suggest an idea or to ask a question is to start a discussion.

Creating pull requests

Contributions are welcome! If you know how to fix an issue, you can create a pull request with the necessary changes that we can then add to Scratch Addons.

If you're making a new addon, our FAQ page will teach you how to make one.

  1. If you have something in mind, want to report a bug, or anything else, it's best if you create or find an issue first (see above). That way, we can discuss it before you start a pull request.
  2. Fork this repository if you haven't already.
  3. If you already have a fork, make sure to sync its master branch to ensure your fork of Scratch Addons is up to date with ours.
  4. Clone Scratch Addons and load it into your browser so you can make and test your changes.
  5. Create a new branch from the master branch.
  6. Create, commit, and push your changes. Make sure you're committing to your new branch.
  7. Go to the website and enable workflows in Actions on your fork so we can automatically clean up your code if necessary.
  8. Finally, create a pull request on the origin repository (ScratchAddons/ScratchAddons). We will review your changes and talk about any further improvements if necessary.

(The linked information shows you how to use Git to commit your changes, but you can also use the website, GitHub Desktop, Visual Studio Code, or any other software that lets you make your changes.)