This repository was archived by the owner on Oct 15, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
This repository was archived by the owner on Oct 15, 2021. It is now read-only.
Create CONTRIBUTING.md #39
Copy link
Copy link
Closed
Labels
HacktoberfestHacktoberfestHacktoberfest
Description
Issue Summary
Our rep is in need of a CONTRIBUTING.md
Content to include
## Welcome to the Mile Two contributing guide
Thanks for investing your time in contributing to our project!
Please keep our community approachable and respectable, by following a few standards. It is our goal to make participation in the Mile Two open-source community a harassment-free environment for everyone.
## Our Standards (as co-oped from [GIthub's Contribution Code of Conduct](https://github.com/github/docs/blob/8a3e0900ce997078c46380765447afb372cbd39d/CODE_OF_CONDUCT.md)
__Examples of behavior that contributes to a positive environment for our community include__
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
__Examples of unacceptable behavior include__
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information (PII), such as a physical or email address, without their explicit permission
- Contacting individual members, contributors, or leaders privately, outside designated community mechanisms, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
## Getting Started
### Issues
#### Create a new issue
If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
#### Solve an issue
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information.
### Making Changes
#### Fork our repo
- Create a branch related to the issue you plan on working.
### Pull Requests
- Create a Pull Request from your `forked` repo's issue branch
- If there are review comments, update them
- Commit and push changes
- Reviewer merges your PR!
🥳 Hurray! You have contributed to our project! 🥳
Reference Materials
There is a guide in the GitHub Docson how to go about creating one if you are in need of help.
Metadata
Metadata
Assignees
Labels
HacktoberfestHacktoberfestHacktoberfest