Thank you for investing your time in contributing to our project!
Read our Code of Conduct to keep our community approachable and respectable.
We welcome contributions from the community! Whether it's bug reports, feature requests, or code contributions, we appreciate your help in making this project better.
Table of Contents
If you encounter a bug or want to suggest a new feature, please open an issue on our GitHub on the Repository in question. When creating a new issue, please provide as much detail as possible, including steps to reproduce the issue (for bugs) and a clear description of the proposed feature.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR on the main StudioCMS Monorepo.
If you'd like to contribute code to this project, please follow the steps below:
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.
- 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 the changes once you are happy with them.
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.
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.
StudioCMS is a global project, and we want to make it accessible to everyone. If you are fluent in multiple languages, you can help us translate StudioCMS into your language.
Current translation status:
Visit our i18n dashboard to help translate StudioCMS into your language. If your language is not listed, you can add it within the dashboard.
If you would prefer to contribute translations directly to the repository, the translations are stored in the packages/studiocms_core/src/i18n/translations directory. You can find the English translations in the en-us.json file.
Once the translations have been added, they will be added to the StudioCMS i18n configuration and will be available in the next release.
Coming soon! We are working on prepping to translate the StudioCMS documentation. If you are interested in helping with this, please reach out to us on Discord