Thank you for considering contributing to Zwin!!!
Read our Code of Conduct to keep our community approachable and respectable.
This guide applies to repositories in the zwin-project, but instructions within each repository will always take precedence over this guide, unless otherwise noted.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
Check the overall contribution guides to see what types of contributions we accept. Some don't even require writing a single line of code.
Before submitting a new issue, please search if an issue already exists. If a related issue doesn't exist, you can open a new issue.
If the repository has issue forms, use them as much as possible. However, it is not always necessary to follow the form if it is easier to express your ideas clearly without it.
If you are trying to make a significant change, we strongly recommend that you discuss the proposal with the maintainers, in case your changes do not match the maintainers' milestone. Neither you nor we will be happy to see your hard work go to waste.
If you have a concrete plan or idea, please share it by submitting an issue. If you need a discussion to form a concrete specification or implementation plan, please contact us on discord.
- Fork the repository.
- Make your changes and test them locally.
- Commit your update.
- File a pull request.
- Don't forget to link PR to an issue if you are solving one.
- Follow the instructions in the PR template.
- The maintainers will review your proposal.
- They may ask for changes to be made before a PR can be merged.
- The maintainers will merge the PR at the appropriate timing.
- Congratulations 🎉🎉 Your PR is merged!
Your changes will be published in the next release.