If you want to contribute to Andromeda means that you're awesome!
Many thanks to MaterialUI, this document was heavily inspired by their awesome documentation.
The following steps will help you to contribute on the right way and get your PR merged easily.
Andromeda has adopted the Contributor Covenant as its Code of Conduct. We expect that our contributors be aware of it. Please read the full text before starting to code to understand what actions will and will not be tolerated.
Andromeda is a community project, therefore, Pull Requests are always welcome. However, before working on a large change, it is best to open an issue first to discuss it with the maintainers.
If it is your first Pull Request, this series of videos are a great source to learn more about Pull Requests: How to contribute to an open source project on github
Tips to increase the chance of being accepted:
- Keep your Pull Request small.
- Don't bundle more than one feature or bug fix per Pull Request. It's often better to create two smaller Pull Requests than one big one.
-
Fork the repository.
-
Clone the fork to your local machine and add upstream remote:
git clone [email protected]:<yourname>/andromeda.git
cd andromeda
git remote add upstream [email protected]:mui-org/andromeda.git
Synchronize your local master branch with the upstream one:
git checkout master
git pull upstream master
Double check if the environment is set and working fine, the instructions can be seen here
Create a new topic branch:
git checkout -b my-topic-branch
Make changes, commit and push to your fork:
git push -u
Go to the repository and make a Pull Request. The core team is monitoring for Pull Requests. We will review your Pull Request and either merge it, request changes to it, or close it with an explanation.
Keep in mind that GitHub will automatically run the CI. Therefore, do a double check on the linters, check if you are not adding any credential file and if all the tests are passing.
Make sure you install the git pre-commit hook. For more details, see the hooks/ directory.