Skip to content

Latest commit

 

History

History
69 lines (54 loc) · 3.25 KB

contributing.md

File metadata and controls

69 lines (54 loc) · 3.25 KB
Raw

Contributing to Yargs

Me hearties, we would love to have you contribute to yargs!

Contributing

  1. Look through the existing issues and see if your idea is something new.
  2. Create a new issue, or comment on an existing issue that you would like to help solve:
    • it's usually best to get some feedback before proceeding to write code.
  3. fork the yargs repo, and clone it to your computer:
  1. make sure that you write unit-test for any code that you write for yargs:
  • we use the standard coding style, which will validate your style when you run tests.
  • look through our extensive test suite in /test to get an idea for how to write unit-tests for this codebase.
  1. make sure you are comfortable with the Code of Conduct outlined below.

Contributor Code of Conduct

As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery
  • Personal attacks
  • Trolling or insulting/derogatory comments
  • Public or private harassment
  • Publishing other's private information, such as physical or electronic addresses, without explicit permission
  • Other unethical or unprofessional conduct

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident.

This Code of Conduct is adapted from the Contributor Covenant, version 1.3.0, available at http://contributor-covenant.org/version/1/3/0/