github.com/datreeio/datree@v1.9.22-rc/CONTRIBUTING.md (about)

     1  # Contributing Guide
     2  
     3  We would love for you to contribute to this project and help make it even better than it is today!
     4  As a contributor, here are the guidelines we would like you to follow:
     5  
     6   - [Code of Conduct](#coc)
     7   - [Question or Problem?](#question)
     8   - [Issues and Bugs](#issue)
     9   - [Feature Requests](#feature)
    10   - [Submission Guidelines](#submit)
    11   - [Commit Message Guidelines](#commit)
    12  
    13  
    14  ## <a name="coc"></a> Code of Conduct
    15  
    16  Help us keep this community open and inclusive.
    17  
    18  ## <a name="question"></a> Got a Question or Problem?
    19  
    20  Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests.  
    21  Instead, we recommend using "[Discussions](https://github.com/datreeio/datree/discussions)" to ask support-related questions.  
    22  You can also email us at oss+support@datree.io.
    23  
    24  ## <a name="issue"></a> Found a Bug?
    25  
    26  If you find a bug in the source code, you can help us by [submitting an issue](#submit-issue) or even better, you can [submit a Pull Request](#submit-pr) with a fix.
    27  
    28  ## <a name="feature"></a> Missing a Feature?
    29  You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub Repository.
    30  
    31  ## <a name="submit"></a> Submission Guidelines
    32  
    33  ### <a name="submit-issue"></a> Submitting an Issue
    34  
    35  Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
    36  
    37  We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it.
    38  In order to reproduce bugs, we require that you provide a minimal reproduction.
    39  Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions.
    40  
    41  A minimal reproduction allows us to quickly confirm a bug (or point out a coding problem) as well as confirm that we are fixing the right problem.
    42  
    43  We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs.
    44  Often, developers find coding problems themselves while preparing a minimal reproduction.
    45  We understand that sometimes it might be hard to extract essential bits of code from a larger codebase but we really need to isolate the problem before we can fix it.
    46  
    47  Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that doesn't have enough info to be reproduced.
    48  
    49  You can file new issues by selecting from our [new issue templates](https://github.com/datreeio/datree/issues/new/choose) and filling out the issue template.
    50  
    51  
    52  ### <a name="submit-pr"></a> Submitting a Pull Request (PR)
    53  
    54  Before you submit your Pull Request (PR) consider the following guidelines:
    55  
    56  1. Search [GitHub](https://github.com/datreeio/datree/pulls) for an open or closed PR that relates to your submission.
    57     You don't want to duplicate existing efforts.
    58  
    59  2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add.
    60     Discussing the design upfront helps to ensure that we're ready to accept your work.
    61  
    62  3. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the datreeio/datree repo.
    63  
    64  4. In your forked repository, make your changes in a new git branch:
    65  
    66       ```shell
    67       git checkout -b my-fix-branch main
    68       ```
    69  
    70  5. Create your patch, **including appropriate test cases**.
    71  
    72  6. Follow our [Coding Rules](#rules).
    73  
    74  7. Run the full test suite, as described in the [developer documentation][dev-doc], and ensure that all tests pass.
    75  
    76  8. Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit).
    77     Adherence to these conventions is necessary because release notes are automatically generated from these messages.
    78  
    79       ```shell
    80       git commit --all
    81       ```
    82      Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
    83  
    84  9. Push your branch to GitHub:
    85  
    86      ```shell
    87      git push origin my-fix-branch
    88      ```
    89  
    90  10. In GitHub, send a pull request to `datree:main`.
    91  
    92  ### Reviewing a Pull Request
    93  
    94  The maintainers team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following the code of conduct.
    95  
    96  ## <a name="commit"></a> Commit Message Format
    97  
    98  *This specification is inspired by and supersedes the [AngularJS commit message format][commit-message-format].*
    99  
   100  We have very precise rules over how our Git commit messages must be formatted.
   101  This format leads to **easier to read commit history**.
   102  
   103  Each commit message **header** must conform to the [Commit Message Header](#commit-header) format.
   104  
   105  #### <a name="commit-header"></a>Commit Message Header
   106  
   107  ```
   108  <type>: <short summary>
   109  ```
   110  
   111  ##### Type
   112  
   113  Must be one of the following:
   114  
   115  * **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
   116  * **ci**: Changes to our CI configuration files and scripts (example scopes: Travis CI, GitHub Actions, CircleCI)
   117  * **docs**: Documentation only changes
   118  * **feat**: A new feature
   119  * **fix**: A bug fix
   120  * **perf**: A code change that improves performance
   121  * **refactor**: A code change that neither fixes a bug nor adds a feature
   122  * **test**: Adding missing tests or correcting existing tests
   123  
   124  
   125  ##### Short summary
   126  
   127  Use the summary field to provide a succinct description of the change:
   128  
   129  * use the imperative, present tense: "change" not "changed" nor "changes"
   130  * don't capitalize the first letter
   131  * no dot (.) at the end
   132  
   133  If you have more than one GitHub accounts, the following documents can help you sort out issues with GitHub accounts and multiple email addresses:
   134  
   135    * https://help.github.com/articles/setting-your-commit-email-address-in-git/
   136    * https://stackoverflow.com/questions/37245303/what-does-usera-committed-with-userb-13-days-ago-on-github-mean
   137    * https://help.github.com/articles/about-commit-email-addresses/
   138    * https://help.github.com/articles/blocking-command-line-pushes-that-expose-your-personal-email-address/