yargs.github.io/contributing/index.html at 9ed48b41b3a69b3f2c4bfc0eb5c3cdcae2e1629c · yargs/yargs.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
---
layout: default
title: Contributing
---

<div class="wrapper">

  <div class="contributing-wrapper">

    <div class="page-title pink-highlight">
      Contributing to Yargs
    </div>

    <p id="description--main">
      Me hearties, we would love to have you contribute to yargs!
    </p>

    <div class="page-heading">
      Contributing
    </div>

    <ol class="description">

      <li> Look through the existing issues and see if your idea is something new. </li>
      <li> Create a <a href="https://github.com/yargs/yargs/issues">new issue</a>, or comment on an existing issue that you would like to help solve:
        <ul>
          <li> it's usually best to get some feedback before proceeding to write code.</li>
        </ul>
      </li>

      <li> fork the yargs repo, and clone it to your computer:
        <ul>
          <li> GitHub has <a href="https://help.github.com/articles/using-pull-requests/">great documentation</a> regarding writing your first pull request. </li>
        </ul>
      </li>

      <li> make sure that you write unit-test for any code that you write for yargs:
        <ul>
          <li> we use <a href="https://github.com/feross/standard">standard</a> coding style, which will validate your style when you run tests </li>

          <li> look through our extensive test suite in <a href="https://github.com/yargs/yargs/issues">/test</a> to get an idea for how to write unit-tests for this codebase. </li>
        </ul>
      </li>

      <li> make sure you are comfortable with the Code of Conduct outlined below. </li>
    </ol>

    <div class="page-heading">
      Contributor Code of Conduct
    </div>

    <p class="description">
      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.

    </p>
    <p class="description">
      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.
    </p>

    <p class="description">
      Examples of unacceptable behavior by participants include:
    </p >

    <ol class="description">
      <li> The use of sexualized language or imagery </li>
      <li> Personal attacks </li>
      <li> Trolling or insulting/derogatory comments </li>
      <li> Public or private harassment </li>
      <li> Publishing other's private information, such as physical or electronic addresses, without explicit permission </li>
      <li> Other unethical or unprofessional conduct </li>
    </ol>

    <p class="description">
      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.
    </p>

    <p class="description">
      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.
    </p>

    <p class="description">
      This Code of Conduct applies both within project spaces and in public spaces
      when an individual is representing the project or its community.
    </p>

    <p class="description">
      Instances of abusive, harassing, or otherwise unacceptable behavior may be
      reported by contacting a project maintainer at ben@npmjs.com. 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.
    </p>

    <p class="description">
      This Code of Conduct is adapted from the <a href="http://contributor-covenant.org">Contributor Covenant</a>, version 1.3.0, available at <a href="http://contributor-covenant.org/version/1/3/0/">http://contributor-covenant.org/version/1/3/0/</a>
    </p>

  </div>

</div>