Sha256: 3de9aa3aed21274b61d1eb81adc97c90bc96f59c6d1335218be05637861470e1

Contents?: true

Size: 1.94 KB

Versions: 5

Compression:

Stored size: 1.94 KB

Contents

## Welcome to Matey's Contribution Guidelines
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.](https://github.com/harled/matey/blob/master/CODE_OF_CONDUCT.md)

### For New Contributors:
Be sure to take a look at the [README](https://github.com/harled/matey/blob/main/README.md) to get a sense of what Matey does and how it works

### Contribution Steps:
Want to help us out? Here are some steps to make sure you are contributing according to our guidelines.

1. Find an issue you like, or create a new issue [here.](https://github.com/harled/matey/issues)
  
Please ask if you have any questions or need clarification on creating a new issue, or related to any existing issue! 🤔

2. 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)`

3. Get on your local machine and [ensure you have the repo cloned.](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) Checkout the branch you just made with `git checkout branch-name` and pull the latest merged changes from the repo with `git pull origin main` to make sure you have the most up-to-date code from the repo. 👩‍💻
4. 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. 🌟
5. 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](https://www.dataschool.io/how-to-contribute-on-github/)

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
matey-0.2.0 docs/CONTRIBUTING.md
matey-0.1.6 docs/CONTRIBUTING.md
matey-0.1.5 docs/CONTRIBUTING.md
matey-0.1.4 docs/CONTRIBUTING.md
matey-0.1.3 docs/CONTRIBUTING.md