github.com/qri-io/qri@v0.10.1-0.20220104210721-c771715036cb/CONTRIBUTOR.md (about) 1 # Contributing to Qri 2 3 We'd love for you to contribute to our source code and to make Qri even better. 4 5 Here are the guidelines we'd like you to follow: 6 7 * [Code of Conduct](#coc) 8 * [Questions and Problems](#question) 9 * [Issues and Bugs](#issue) 10 * [Feature Requests](#feature) 11 * [Improving Documentation](#docs) 12 * [Issue Submission Guidelines](#submit) 13 * [Pull Request Submission Guidelines](#submit-pr) 14 * [Signing the CLA](#cla) 15 16 ## <a name="coc"></a> Code of Conduct 17 18 Help us keep Qri open and inclusive. Please read and follow our [Code of Conduct][coc]. 19 20 ## <a name="requests"></a> Questions, Bugs, Features 21 22 ### <a name="issue"></a> Found an Issue or Bug? 23 24 If you find a bug or are having a problem using Qri, help us by submitting an issue to our 25 [GitHub Repository][github]. Even better, you can submit a Pull Request with a fix. 26 27 **Please see the [Submission Guidelines](#submit) below.** 28 29 ### <a name="feature"></a> Missing a Feature? 30 31 You can request a new feature by submitting an issue to our [GitHub Repository][github-issues]. 32 33 If you would like to implement a new feature then consider what kind of change it is: 34 35 * **Major Changes** that you wish to contribute to the project should be discussed first in an 36 [GitHub issue][github-issues] that outlines the changes and benefits of the feature. 37 You may be asked to write an [rfc](https://github.com/qri-io/rfcs) that formally describes the 38 feature and the changes that are required, and opens the idea up for comment. 39 * **Small Changes** can directly be crafted and submitted to the [GitHub Repository][github] 40 as a Pull Request. See the section about [Pull Request Submission Guidelines](#submit-pr), and 41 for detailed information the [core development documentation][developers]. 42 43 ### <a name="docs"></a> Want a Doc Fix? 44 45 Should you have a suggestion for the documentation, you can open an issue and outline the problem 46 or improvement you have - however, creating the doc fix yourself is much better! 47 48 If you want to help improve the docs, it's a good idea to let others know what you're working on to 49 minimize duplication of effort. Create a new issue (or comment on a related existing one) to let 50 others know what you're working on. 51 52 If you're making a small change (typo, phrasing) don't worry about filing an issue first. Use the 53 friendly blue "Improve this doc" button at the top right of the doc page to fork the repository 54 in-place and make a quick change on the fly. The commit message is preformatted to the right type 55 and scope, so you only have to add the description. 56 57 For large fixes, please build and test the documentation before submitting the PR to be sure you 58 haven't accidentally introduced any layout or formatting issues. You should also make sure that your 59 commit message follows the **[Commit Message Guidelines][developers.commits]**. 60 61 ## <a name="submit"></a> Issue Submission Guidelines 62 Before you submit your issue search the archive, maybe your question was already answered. 63 64 If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize 65 the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. 66 67 Please use this form when filing a [new issue][github-new-issue]: 68 69 * **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps 70 * **Motivation for or Use Case** - explain why this is a bug for you 71 * **Qri Version(s)** - is it a regression? 72 * **Operating System** - is this a problem with all browsers or only specific ones? 73 * **Reproduce the Error** - please provide an unambiguous set of steps we can use to reproduce the error. 74 * **Related Issues** - has a similar issue been reported before? 75 * **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be 76 causing the problem (line of code or commit) 77 78 ## <a name="submit-pr"></a> Pull Request Submission Guidelines 79 Before you submit your pull request consider the following guidelines: 80 81 * Search [GitHub](https://github.com/qri-io/qri/pulls) for an open or closed Pull Request 82 that relates to your submission. You don't want to duplicate effort. 83 * Create the [development environment][developers.setup] 84 * Make your changes in a new git branch: 85 86 ```shell 87 git checkout -b my-fix-branch master 88 ``` 89 90 * Create your patch commit. 91 * Follow our [Coding Rules][developers.rules]. 92 * Commit your changes using a descriptive commit message that follows our 93 [commit message conventions][developers.commits]. Adherence to the 94 [commit message conventions][developers.commits] is required, because release notes are 95 automatically generated from these messages. 96 97 ```shell 98 git commit -a 99 ``` 100 Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. 101 * Push your branch to GitHub: 102 103 ```shell 104 git push origin my-fix-branch 105 ``` 106 107 * In GitHub, send a pull request to ` qri:master`. This will trigger the check of the 108 [Contributor License Agreement](#cla). 109 110 * If we suggest changes, then: 111 112 * Make the required updates. 113 * Re-run the Qri test suite to ensure tests are still passing. 114 * Commit your changes to your branch (e.g. `my-fix-branch`). 115 * Push the changes to your GitHub repository (this will update your Pull Request). 116 117 You can also amend the initial commits and force push them to the branch. 118 119 ```shell 120 git rebase master -i 121 git push origin my-fix-branch -f 122 ``` 123 124 This is generally easier to follow, but seperate commits are useful if the Pull Request contains 125 iterations that might be interesting to see side-by-side. 126 127 That's it! Thank you for your contribution! 128 129 #### After your pull request is merged 130 131 After your pull request is merged, you can safely delete your branch and pull the changes 132 from the main (upstream) repository: 133 134 * Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: 135 136 ```shell 137 git push origin --delete my-fix-branch 138 ``` 139 140 * Check out the master branch: 141 142 ```shell 143 git checkout master -f 144 ``` 145 146 * Delete the local branch: 147 148 ```shell 149 git branch -D my-fix-branch 150 ``` 151 152 * Update your master with the latest upstream version: 153 154 ```shell 155 git pull --ff upstream master 156 ``` 157 158 ## <a name="cla"></a> Signing the Contributor License Agreement (CLA) 159 160 Upon submmitting a Pull Request, a friendly bot will ask you to sign our CLA if you haven't done 161 so before. Unfortunately, this is necessary for documentation changes, too. 162 It's a quick process, we promise! 163 164 * For individuals we have a [simple click-through form][individual-cla]. 165 * For corporations we'll need you to 166 [print, sign and one of scan+email, fax or mail the form][corporate-cla]. 167 168 169 170 [coc]: https://github.com/qri-io/qri/blob/master/code_of_conduct.md 171 [corporate-cla]: http://code.google.com/legal/corporate-cla-v1.0.html 172 [developers]: DEVELOPERS.md 173 [developers.setup]: DEVELOPERS.md#setup 174 [developers.commits]: DEVELOPERS.md#commits 175 [developers.rules]: DEVELOPERS.md#rules 176 [github-issues]: https://github.com/qri-io/qri/issues 177 [github-new-issue]: https://github.com/qri-io/qri/issues/new 178 [github]: https://github.com/qri-io/qri 179 [individual-cla]: http://code.google.com/legal/individual-cla-v1.0.html 180 [jsfiddle]: http://jsfiddle.net/ 181 [plunker]: http://plnkr.co/edit 182 183 184 ###### This documentation has been adapted from the [Data Together](https://github.com/datatogether/datatogether), [Hyper](https://github.com/zeit/hyper), and [AngularJS](https://github.com/angular/angularJS) documentation.