Thank you for considering contributing to React Native QR Code Composer! As the creators and maintainers of this project, we want to ensure that the project lives and continues to grow. Not blocked by any singular person's computer time. One of the simplest ways of doing this is by encouraging a larger set of shallow contributors. Through this, we hope to mitigate the problems of a project that needs updates, but there is no-one who has the power to do so.
We adhere to a trunk-based development approach, maintaining a single protected branch:
main: This is our primary branch where all development occurs, including new features, bug fixes, and updates. It's vital thatmainremains stable and always ready for deployment.
Contributors are encouraged to create a new branch for each set of related changes. These branches are merged back into main through a pull request once they're ready. When it comes to commit messages, We follow the conventional commits specification, and while not mandatory, using gitmoji for commit types is encouraged.
By contributing to this project, you agree to abide by its terms.
Our release process is manual, ensuring each version aligns with our high standards for stability and completeness. Discussions about when to cut a release and what it should include are encouraged among all participants.
Releases are prepared on branches named release/x.y.z—reflecting Semantic Versioning (SemVer). Rigorous testing and community feedback are sought to finalize each release. Once the version is stable, and functionality is verified, the release is tagged (x.y.z) and published to appropriate distribution channels.
If you get a merged Pull Request, regardless of content (typos, code, doc fixes), then you are eligible for push access to this repository.
Offhand, it is easy to imagine that this would make code quality suffer, but in reality it offers fresh perspectives to the codebase and encourages ownership from people who are depending on the project. If you are building a project that relies on this codebase, then you probably have the skills to improve it and offer valuable feedback.
Everyone comes in with their own perspective on what a project could/should look like, and encouraging discussion can help expose good ideas sooner.
It can be overwhelming to be offered the chance to wipe the source code for a project. Do not worry, we do not let you push to main. All code is peer-reviewed, and we have the convention that someone other than the submitter should merge non-trivial pull requests.
As a contributor, you can merge other people's pull requests, or other contributors can merge yours. You will not be assigned a pull request, but you are welcome to jump in and take a code review on topics that interest you.
This project is not continuously deployed, there is space for debate after review too. Offering everyone the chance to revert, or make an amending pull request. If it feels right, merge.
It is normal for a first pull request to be a potential fix for a problem, and moving on from there to helping the project's direction can be difficult. We try to help contributors cross that barrier by offering good first step issues. These issues can be fixed without feeling like you are stepping on toes. Ideally, these are non-critical issues that are well-defined. They will be purposely avoided by mature contributors to the project, to make space for others.
We aim to keep all project discussion inside GitHub issues. This is to make sure valuable discussion is accessible via search. If you have questions about how to use the library, or how the project is running - GitHub issues are the go-to tool for this project.
To quote @alloy from this issue:
Do not ever feel bad for not contributing to open source.
We want contributors to provide ideas, keep the ship shipping and to take some of the load from others. It is non-mandatory; we’re here to get things done in an enjoyable way. 🏆
The fact that you will have push access will allow you to:
- Avoid having to fork the project if you want to submit other pull requests as you will be able to create branches directly on the project.
- Help triage issues and merge pull requests.
- Pick up the project if other maintainers move their focus elsewhere.
It is up to you to use those superpowers or not though 😉
If someone submits a pull request that is not perfect, and you are reviewing, it is better to think about the PR's motivation rather than the specific implementation. Having braces on the wrong line should not be a blocker. Though we do want to keep test coverage high, we will work with you to figure that out together.
Afonso has contacts on their GitHub profile, and are happy to talk about any problems.
The original source of this document can be found at https://github.com/moya/contributors.
If you made it all the way to the end, bravo, you are awesome. You can include the 🛹 emoji in the top of your ticket to signal to us that you did in fact read this file and are trying to conform to it as best as possible: :skateboard:.