Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 2.62 KB
Raw

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

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

  • Prior to opening your pull request add yourself as a contributor

    npm run contributors:add keonik doc

    where keonik is your github username and doc is the type of contribution

    Update all-contributors list

    npm run contributors:generate

  • 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! 🥳