File: contributing.md

package info (click to toggle)
node-yargs 15.3.1%2Brepack-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,740 kB
  • sloc: javascript: 12,094; makefile: 2
file content (20 lines) | stat: -rw-r--r-- 1,070 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# Contributing to Yargs

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

If you are looking to update the website, check out [yargs/yargs.github.io](https://github.com/yargs/yargs.github.io).

## 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:
    * GitHub has [great documentation](https://help.github.com/articles/using-pull-requests/) regarding writing your first pull request.
4. make sure that you write unit-test for any code that you write for yargs:
    * we use the [standard](https://github.com/feross/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.
5. make sure you are comfortable with the Code of Conduct outlined below.