github.com/WindomZ/go-commander@v1.2.2/CONTRIBUTING.md (about)

     1  # Contributing to go-commander
     2  
     3  First and foremost, thank you! We appreciate that you want to contribute to go-commander, your time is valuable, and your contributions mean a lot to us.
     4  
     5  **What does "contributing" mean?**
     6  
     7  Creating an issue is the simplest form of contributing to a project. But there are many ways to contribute, including the following:
     8  
     9  - Updating or correcting documentation
    10  - Feature requests
    11  - Bug reports
    12  
    13  If you'd like to learn more about contributing in general, the [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing) has a lot of useful information.
    14  
    15  **Showing support for go-commander**
    16  
    17  Please keep in mind that open source software is built by people like you, who spend their free time creating things the rest the community can use.
    18  
    19  Don't have time to contribute? No worries, here are some other ways to show your support for go-commander:
    20  
    21  - star the [project](https://github.com/WindomZ/go-commander)
    22  - tweet your support for go-commander
    23  
    24  ## Issues
    25  
    26  ### Before creating an issue
    27  
    28  Please try to determine if the issue is caused by an underlying library, and if so, create the issue there. Sometimes this is difficult to know. We only ask that you attempt to give a reasonable attempt to find out. Oftentimes the readme will have advice about where to go to create issues.
    29  
    30  Try to follow these guidelines
    31  
    32  - **Investigate the issue**:
    33  - **Check the readme** - oftentimes you will find notes about creating issues, and where to go depending on the type of issue.
    34  - Create the issue in the appropriate repository.
    35  
    36  ### Creating an issue
    37  
    38  Please be as descriptive as possible when creating an issue. Give us the information we need to successfully answer your question or address your issue by answering the following in your issue:
    39  
    40  - **version**: please note the version of go-commander are you using
    41  - **extensions, plugins, helpers, etc** (if applicable): please list any extensions you're using
    42  - **error messages**: please paste any error messages into the issue, or a [gist](https://gist.github.com/)
    43  
    44  ## Above and beyond
    45  
    46  Here are some tips for creating idiomatic issues. Taking just a little bit extra time will make your issue easier to read, easier to resolve, more likely to be found by others who have the same or similar issue in the future.
    47  
    48  - read the [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing)
    49  - take some time to learn basic markdown. This [markdown cheatsheet](https://gist.github.com/jonschlinkert/5854601) is super helpful, as is the GitHub guide to [basic markdown](https://help.github.com/articles/markdown-basics/).
    50  - Learn about [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). And if you want to really go above and beyond, read [mastering markdown](https://guides.github.com/features/mastering-markdown/).
    51  - use backticks to wrap code. This ensures that code will retain its format, making it much more readable to others
    52  - use syntax highlighting by adding the correct language name after the first "code fence"
    53  
    54  
    55  [node-glob]: https://github.com/isaacs/node-glob
    56  [micromatch]: https://github.com/jonschlinkert/micromatch
    57  [so]: http://stackoverflow.com/questions/tagged/go-commander