Dear contributors, we, the Miracle Factory team, would like to thank you for your attention and dedication to the refining of this repository and our community. We hope that you enjoy the collaboration and the contribution you make to the development of this repository ❤️.
At Miracle Factory, we value the equity of our contributors. In order to foster a healthy community, we ask that you read and follow our Code of Conduct, and we intend to enforce this code in all of our repositories. And we would also like to remind you to follow this code in your lives out side of GitHub and the Miracle Factory community.
If you are new to collaborating on GitHub, we recommend that you read and explore the GitHub Documentation before starting. Here are some resources to get you started:
Issues are the main source of feedback and discussion for the development of this repository. We encourage you to open issues on GitHub so that we can address them and improve the quality of our codebase.
If you have any suggestions or feedback on this repository, please go to the Issues tab in our repository and open a new issue (the Issues tab is located at the upper-left side of the repo homepage). You can make use of our Issue Template to help you create a new issue:
You can have a look at the issues that are still open and make the necessary changes to them. If you have a solution to the issue, please create a pull request to resolve the issue, please also remember to link the pull request to this issue.
As a contributor, the changes that you wish to make to this repository is usually reflected via a pull request.
In the situation where you have a new feature or a bug fix that you wish to contribute, you would first fork the repository that you wish to contibute to, and commit your changes to your forked repository(which will be under your adminstration). Then, you would create a pull request to the main branch of the original repository. You may use our Pull Request Template to help you create a pull request.
If you have some ideas regarding the opened pull requests, you can make use of the discussion board to discuss them with the other contributors.
Tips:
- You can create separate comments for each line of the code that has been changed.
- You can add tags to your pull requests to help others identify the nature of the change more quickly.
- Discussing your chanegs with the other contributors is a good way to help the others understand your ideas and get your pull request accepted.
After you have created a pull request, your pull request will be reviewed by other contributors of this repository.
You can request a code review from the community leaders. Please comment on your pull request to help them undertsand your changes easily. Under normal circumstances, there could be three outcomes for your pull request:
- If the reviewers think that your pull request is a good fit for the repository, they will accept your pull request.
- If the reviewers think that there is something off with your pull request, they might ask you to make changes to your pull request.
- If they think that your pull request is not a good fit for the repository, they might ask you to remove your pull request.
Once your pull request is approved, you will be able to merge it to the main branch of the repository(if all auto tests checks out). Alternatively, you can choose to let the administrators merge your pull request. Your pull request will be closed after the merge, and your changes will be reflected in the main branch immediately.
You are now an official contributor to this repository! 🎉
Enjoy your collab with the other contributors in our community! 🤗
May the source be with you, always :)