|
| 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 | + - [Signing the CLA](#cla) |
| 13 | + |
| 14 | + |
| 15 | +## <a name="coc"></a> Code of Conduct |
| 16 | + |
| 17 | +Help us keep this community open and inclusive. |
| 18 | + |
| 19 | +## <a name="question"></a> Got a Question or Problem? |
| 20 | + |
| 21 | +Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. |
| 22 | +Instead, we recommend using "[Discussions](https://github.com/datreeio/datree/discussions)" to ask support-related questions. |
| 23 | +You can also email is at [email protected]. |
| 24 | + |
| 25 | + |
| 26 | +## <a name="issue"></a> Found a Bug? |
| 27 | + |
| 28 | +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. |
| 29 | + |
| 30 | + |
| 31 | +## <a name="feature"></a> Missing a Feature? |
| 32 | +You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub Repository. |
| 33 | + |
| 34 | +## <a name="submit"></a> Submission Guidelines |
| 35 | + |
| 36 | + |
| 37 | +### <a name="submit-issue"></a> Submitting an Issue |
| 38 | + |
| 39 | +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. |
| 40 | + |
| 41 | +We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. |
| 42 | +In order to reproduce bugs, we require that you provide a minimal reproduction. |
| 43 | +Having a minimal reproducible scenario gives us a wealth of important information without going back and forth to you with additional questions. |
| 44 | + |
| 45 | +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. |
| 46 | + |
| 47 | +We require a minimal reproduction to save maintainers' time and ultimately be able to fix more bugs. |
| 48 | +Often, developers find coding problems themselves while preparing a minimal reproduction. |
| 49 | +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. |
| 50 | + |
| 51 | +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. |
| 52 | + |
| 53 | +You can file new issues by selecting from our [new issue templates](https://github.com/datreeio/datree/blob/issues-template/.github/ISSUE_TEMPLATE/bug_report.md) and filling out the issue template. |
| 54 | + |
| 55 | + |
| 56 | +### <a name="submit-pr"></a> Submitting a Pull Request (PR) |
| 57 | + |
| 58 | +Before you submit your Pull Request (PR) consider the following guidelines: |
| 59 | + |
| 60 | +1. Search [GitHub](https://github.com/datreeio/datree/pulls) for an open or closed PR that relates to your submission. |
| 61 | + You don't want to duplicate existing efforts. |
| 62 | + |
| 63 | +2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. |
| 64 | + Discussing the design upfront helps to ensure that we're ready to accept your work. |
| 65 | + |
| 66 | +3. Please sign our [Contributor License Agreement (CLA)](#cla) before sending PRs. |
| 67 | + We cannot accept code without a signed CLA. |
| 68 | + Make sure you author all contributed Git commits with email address associated with your CLA signature. |
| 69 | + |
| 70 | +4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the datreeio/datree repo. |
| 71 | + |
| 72 | +5. In your forked repository, make your changes in a new git branch: |
| 73 | + |
| 74 | + ```shell |
| 75 | + git checkout -b my-fix-branch main |
| 76 | + ``` |
| 77 | + |
| 78 | +6. Create your patch, **including appropriate test cases**. |
| 79 | + |
| 80 | +7. Follow our [Coding Rules](#rules). |
| 81 | + |
| 82 | +8. Run the full test suite, as described in the [developer documentation][dev-doc], and ensure that all tests pass. |
| 83 | + |
| 84 | +9. Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). |
| 85 | + Adherence to these conventions is necessary because release notes are automatically generated from these messages. |
| 86 | + |
| 87 | + ```shell |
| 88 | + git commit --all |
| 89 | + ``` |
| 90 | + Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. |
| 91 | + |
| 92 | +10. Push your branch to GitHub: |
| 93 | + |
| 94 | + ```shell |
| 95 | + git push origin my-fix-branch |
| 96 | + ``` |
| 97 | + |
| 98 | +11. In GitHub, send a pull request to `datree:staging`. |
| 99 | + |
| 100 | +### Reviewing a Pull Request |
| 101 | + |
| 102 | +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. |
| 103 | +
|
| 104 | +## <a name="commit"></a> Commit Message Format |
| 105 | +
|
| 106 | +*This specification is inspired by and supersedes the [AngularJS commit message format][commit-message-format].* |
| 107 | +
|
| 108 | +We have very precise rules over how our Git commit messages must be formatted. |
| 109 | +This format leads to **easier to read commit history**. |
| 110 | +
|
| 111 | +Each commit message **header** must conform to the [Commit Message Header](#commit-header) format. |
| 112 | +
|
| 113 | +#### <a name="commit-header"></a>Commit Message Header |
| 114 | +
|
| 115 | +``` |
| 116 | +<type>: <short summary> |
| 117 | +``` |
| 118 | +
|
| 119 | +##### Type |
| 120 | +
|
| 121 | +Must be one of the following: |
| 122 | +
|
| 123 | +* **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| 124 | +* **ci**: Changes to our CI configuration files and scripts (example scopes: Travis CI, GitHub Actions, CircleCI) |
| 125 | +* **docs**: Documentation only changes |
| 126 | +* **feat**: A new feature |
| 127 | +* **fix**: A bug fix |
| 128 | +* **perf**: A code change that improves performance |
| 129 | +* **refactor**: A code change that neither fixes a bug nor adds a feature |
| 130 | +* **test**: Adding missing tests or correcting existing tests |
| 131 | +
|
| 132 | +
|
| 133 | +##### Short summary |
| 134 | +
|
| 135 | +Use the summary field to provide a succinct description of the change: |
| 136 | +
|
| 137 | +* use the imperative, present tense: "change" not "changed" nor "changes" |
| 138 | +* don't capitalize the first letter |
| 139 | +* no dot (.) at the end |
| 140 | + |
| 141 | +## <a name="cla"></a> Signing the CLA |
| 142 | + |
| 143 | +Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code |
| 144 | +changes to be accepted, the CLA must be signed. It's a quick process, we promise! |
| 145 | +
|
| 146 | +For individuals and corporations, we have a [simple click-through form](https://cla-assistant.io/datreeio/datree). |
| 147 | +
|
| 148 | +If you have more than one GitHub accounts, or multiple email addresses associated with a single GitHub account, you must sign the CLA using the primary email address of the GitHub account used to author Git commits and send pull requests. |
| 149 | +
|
| 150 | +The following documents can help you sort out issues with GitHub accounts and multiple email addresses: |
| 151 | +
|
| 152 | + * https://help.github.com/articles/setting-your-commit-email-address-in-git/ |
| 153 | + * https://stackoverflow.com/questions/37245303/what-does-usera-committed-with-userb-13-days-ago-on-github-mean |
| 154 | + * https://help.github.com/articles/about-commit-email-addresses/ |
| 155 | + * https://help.github.com/articles/blocking-command-line-pushes-that-expose-your-personal-email-address/ |
0 commit comments