github.com/rmarku/gomarkdoc@v0.0.0-20230517164305-78688ebe4325/CONTRIBUTING.md (about)

     1  # Contribution Guide
     2  
     3  ## Issues
     4  
     5  If you have a bug to report or a feature that you'd like to see, head over to
     6  the [issues][] section of the repository to open an issue. Some guidelines:
     7  
     8  - Do a check of the existing issues (both open and closed) to see if anyone had
     9    the same issue/request. If you find something, feel free to add your voice to
    10    the conversation if there's something new to add or or [give the issue a
    11    thumbs up][github reactions] to show you have the same issue/request.
    12  
    13  - Please include the version of Aster that you are using. If you're not on the
    14    latest version, try using that first and see if it fixes your issue.
    15  
    16  - Include specific details about what you were doing and what went wrong and
    17    how to reproduce the issue. Some sample code or a sample gist/repository go a
    18    long way to helping with debugging and finding a fix.
    19  
    20  - Be respectful of others in the conversation. Issues should be a place where
    21    people can discuss what they're seeing, learn and work toward a solution
    22    without worrying about being judged or lambasted.
    23  
    24  - If you have a question rather than an issue or feature request, don't be
    25    afraid to post it in the issues, but please be patient if it takes longer to
    26    get a response. All are encouraged to help answer questions.
    27  
    28  ## Pull Requests
    29  
    30  Do you have a bugfix for an issue, a new feature, or even a fix for a typo in
    31  the documentation? You should open a Pull Request! Some steps to follow:
    32  
    33  1.  If your change is a substantial addition or it will result in a breaking
    34      change to the library, consider first [opening an issue](#issues) to dicuss
    35      the problem and the proposed solution.
    36  
    37  2.  [Fork the repository][github fork] if you haven't before
    38  
    39  3.  [Set up your development environment](#developer-setup) and make your
    40      changes. Also be sure to add tests for your change.
    41  
    42  4.  When you're ready to push your changes, run `npm t` to lint, build and test
    43      your code. Any failures here will cause your pull request's continuous
    44      integration to fail, so it's best to catch it early.
    45  
    46  5.  Once you've pushed your code into your fork, [open a pull request][new pull request] and follow the template to fill in the pull request information.
    47  
    48  ## Developer Setup
    49  
    50  ### Prerequisites
    51  
    52  - [Golang][] 1.13.x or later
    53  - [Mage][] 1.9.x or later
    54  
    55  ### Setting Up
    56  
    57  You can verify that things are up and running properly by executing:
    58  
    59  ```
    60  mage test
    61  ```
    62  
    63  ### Testing
    64  
    65  Once you have made a change, you'll want to make sure that all of the tests are
    66  passing. You can do so by running:
    67  
    68  ```
    69  mage test
    70  ```
    71  
    72  This will run tests and compute code coverage on the source code. You can view a
    73  detailed html coverage report by running:
    74  
    75  ```
    76  mage coverage
    77  ```
    78  
    79  You can also lint the code by running:
    80  
    81  ```
    82  mage lint
    83  ```
    84  
    85  Finally, when you're ready to submit a change, you'll want to make sure that the
    86  documentation for this repository has been regenerated:
    87  
    88  ```
    89  mage doc
    90  ```
    91  
    92  [issues]: https://github.com/rmarku/gomarkdoc/issues
    93  [new pull request]: https://github.com/rmarku/gomarkdoc/compare
    94  [github reactions]: https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
    95  [github fork]: https://help.github.com/articles/fork-a-repo
    96  [golang]: https://golang.org/
    97  [mage]: https://magefile.org/