Bug reports and pull requests are welcome on GitHub at https://github.com/harled/matey. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
Be sure to take a look at the README to get a sense of what Matey does and how it works
Want to help us out? Here are some steps to make sure you are contributing according to our guidelines.
- Find an issue you like, or create a new issue here.
Please ask if you have any questions or need clarification on creating a new issue, or related to any existing issue! 🤔
-
Assign yourself to the issue and create a branch , following GitHub Issue's naming scheme. 🛠️ The naming scheme should follow
(#issueNumber-issue-name)
ie.(#10-create-new-component)
-
Get on your local machine and ensure you have the repo cloned. Checkout the branch you just made with
git checkout branch-name
and pull the latest merged changes from the repo withgit pull origin main
to make sure you have the most up-to-date code from the repo. 👩💻 -
Add your amazing changes along with any documentation you feel would be useful (ie. Update the README if necessary). Then commit and push your changes. 🌟
-
Go back to the repo on GitHub and create a pull request! Then wait for an admin of the repo to get back to your pull request, address any comments, and once you are finally approved, merge your code into Matey! 🎉
If you want some more tips on contributing to GitHub projects, check out this resource from Data School