Code Contributions
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
If you’d like to contribute code to this project, please follow the steps below:
Solve an issue
'Read the “', Solve an issue, '” section'Scan through our existing issues^ to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix.
Make Changes
'Read the “', Make Changes, '” section'-
Fork the repository.
-
Using GitHub Desktop:
- Getting started with GitHub Desktop^ will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo^!
-
Using the command line:
- Fork the repo^ so that you can make your changes without affecting the original project until you’re ready to merge them.
-
-
Install or update Node.js and pnpm, to the versions specified in
.prototools^. -
Create a working branch and start with your changes!
-
Write tests for your changes, if applicable.
-
Update the documentation, if necessary.
Commit your update
'Read the “', Commit your update, '” section'Commit the changes once you are happy with them.
Pull Request
'Read the “', Pull Request, '” section'When you’re finished with the changes, create a pull request, also known as a PR.
- Fill the “Ready for review” template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don’t forget to link PR to issue^ if you are solving one.
- Enable the checkbox to allow maintainer edits^ so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
- We may ask for changes to be made before a PR can be merged, either using suggested changes^ or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved^.
- If you run into any merge issues, checkout this git tutorial^ to help you resolve merge conflicts and other issues.
Your PR is merged!
'Read the “', Your PR is merged!, '” section'Congratulations! The StudioCMS team thanks you. Your contribution will be part of the next release.
Now that you are part of the StudioCMS community, you can help us review other PRs, answer questions, and help other contributors. If you haven’t already, join our Discord^ to connect with other contributors and the StudioCMS team.
Oh and you will see your face in the list of contributors! 🎉