Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(48)

Side by Side Diff: appengine/config_service/ui/bower_components/chai/CONTRIBUTING.md

Issue 2923973003: Added base template for config ui. (Closed)
Patch Set: Created 3 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
(Empty)
1 # Chai Contribution Guidelines
2
3 We like to encourage you to contribute to the Chai.js repository. This should be as easy as possible for you but there are a few things to consider when contrib uting. The following guidelines for contribution should be followed if you want to submit a pull request or open an issue.
4
5 Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they sh ould reciprocate that respect in addressing your issue or assessing patches and features.
6
7 #### Table of Contents
8
9 - [TLDR;](#tldr)
10 - [Contributing](#contributing)
11 - [Bug Reports](#bugs)
12 - [Feature Requests](#features)
13 - [Pull Requests](#pull-requests)
14 - [Releasing](#releasing)
15 - [Support](#support)
16 - [Resources](#resources)
17 - [Core Contributors](#contributors)
18
19 <a name="tldr"></a>
20 ## TLDR;
21
22 - Creating an Issue or Pull Request requires a [GitHub](http://github.com) accou nt.
23 - Issue reports should be **clear**, **concise** and **reproducible**. Check to see if your issue has already been resolved in the [master]() branch or already reported in Chai's [GitHub Issue Tracker](https://github.com/chaijs/chai/issues) .
24 - Pull Requests must adhere to strict [coding style guidelines](https://github.c om/chaijs/chai/wiki/Chai-Coding-Style-Guide).
25 - In general, avoid submitting PRs for new Assertions without asking core contri butors first. More than likely it would be better implemented as a plugin.
26 - Additional support is available via the [Google Group](http://groups.google.co m/group/chaijs) or on irc.freenode.net#chaijs.
27 - **IMPORTANT**: By submitting a patch, you agree to allow the project owner to license your work under the same license as that used by the project.
28
29
30
31 <a name="contributing"></a>
32 ## Contributing
33
34 The issue tracker is the preferred channel for [bug reports](#bugs),
35 [feature requests](#features) and [submitting pull
36 requests](#pull-requests), but please respect the following restrictions:
37
38 * Please **do not** use the issue tracker for personal support requests (use
39 [Google Group](https://groups.google.com/forum/#!forum/chaijs) or IRC).
40 * Please **do not** derail or troll issues. Keep the discussion on topic and
41 respect the opinions of others
42
43 <a name="bugs"></a>
44 ### Bug Reports
45
46 A bug is a **demonstrable problem** that is caused by the code in the repository .
47
48 Guidelines for bug reports:
49
50 1. **Use the GitHub issue search** &mdash; check if the issue has already been r eported.
51 2. **Check if the issue has been fixed** &mdash; try to reproduce it using the l atest `master` or development branch in the repository.
52 3. **Isolate the problem** &mdash; create a test case to demonstrate your issue. Provide either a repo, gist, or code sample to demonstrate you problem.
53
54 A good bug report shouldn't leave others needing to chase you up for more inform ation. Please try to be as detailed as possible in your report. What is your env ironment? What steps will reproduce the issue? What browser(s) and/or Node.js ve rsions experience the problem? What would you expect to be the outcome? All thes e details will help people to fix any potential bugs.
55
56 Example:
57
58 > Short and descriptive example bug report title
59 >
60 > A summary of the issue and the browser/OS environment in which it occurs. If s uitable, include the steps required to reproduce the bug.
61 >
62 > 1. This is the first step
63 > 2. This is the second step
64 > 3. Further steps, etc.
65 >
66 > `<url>` - a link to the reduced test case OR
67 > ```js
68 > expect(a).to.equal('a');
69 > // code sample
70 > ```
71 >
72 > Any other information you want to share that is relevant to the issue being re ported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).
73
74 <a name="features"></a>
75 ### Feature Requests
76
77 Feature requests are welcome. But take a moment to find out whether your idea fi ts with the scope and aims of the project. It's up to *you* to make a strong cas e to convince the project's developers of the merits of this feature. Please pro vide as much detail and context as possible.
78
79 Furthermore, since Chai.js has a [robust plugin API](http://chaijs.com/guide/plu gins/), we encourage you to publish **new Assertions** as plugins. If your featu re is an enhancement to an **existing Assertion**, please propose your changes a s an issue prior to opening a pull request. If the core Chai.js contributors fee l your plugin would be better suited as a core assertion, they will invite you t o open a PR in [chaijs/chai](https://github.com/chaijs/chai).
80
81 <a name="pull-requests"></a>
82 ### Pull Requests
83
84 - PRs for new core-assertions are advised against.
85 - PRs for core-assertion bug fixes are always welcome.
86 - PRs for enhancing the interfaces are always welcome.
87 - PRs that increase test coverage are always welcome.
88 - PRs are scrutinized for coding-style.
89
90 Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
91
92 **Please ask first** before embarking on any significant pull request (e.g. impl ementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
93
94 Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage). Ple ase review the [Chai.js Coding Style Guide](https://github.com/chaijs/chai/wiki/ Chai-Coding-Style-Guide).
95
96 Follow this process if you'd like your work considered for inclusion in the proj ect:
97
98 1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes:
99
100 ```bash
101 # Clone your fork of the repo into the current directory
102 git clone https://github.com/<your-username>/<repo-name>
103 # Navigate to the newly cloned directory
104 cd <repo-name>
105 # Assign the original repo to a remote called "upstream"
106 git remote add upstream https://github.com/<upstream-owner>/<repo-name>
107 ```
108
109 2. If you cloned a while ago, get the latest changes from upstream:
110
111 ```bash
112 git checkout <dev-branch>
113 git pull upstream <dev-branch>
114 ```
115
116 3. Create a new topic branch (off the main project development branch) to contai n your feature, change, or fix:
117
118 ```bash
119 git checkout -b <topic-branch-name>
120 ```
121
122 4. Commit your changes in logical chunks. Use Git's [interactive rebase](https:/ /help.github.com/articles/interactive-rebase) feature to tidy up your commits be fore making them public.
123
124 5. Run you code to make sure it works. If you're still having problems please tr y to run `make clean` and then test your code again.
125
126 ```bash
127 npm test
128 # when finished running tests...
129 git checkout chai.js
130 ```
131
132 6. Locally merge (or rebase) the upstream development branch into your topic bra nch:
133
134 ```bash
135 git pull [--rebase] upstream <dev-branch>
136 ```
137
138 7. Push your topic branch up to your fork:
139
140 ```bash
141 git push origin <topic-branch-name>
142 ```
143
144 8. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description.
145
146 **IMPORTANT**: By submitting a patch, you agree to allow the project owner to li cense your work under the same license as that used by the project.
147
148 <a name="releasing"></a>
149 ## Releasing
150
151 Releases can be **prepared** by anyone with access to the code.
152
153 Simply run `make release-major`, `make release-minor`, or `make-release-patch`
154 and it will automatically do the following:
155
156 - Build chai.js
157 - Bump the version numbers accross the project
158 - Make a commit within git
159
160 All you need to do is push the commit up and make a pull request, one of the cor e contributors will merge it and publish a release.
161
162 ### Publishing a Release
163
164 Anyone who is a core contributor (see the [Core Contributors Heading in the Read me](https://github.com/chaijs/chai#core-contributors)) can publish a release:
165
166 1. Go to te [Releases page on Github](https://github.com/chaijs/chai/releases)
167 2. Hit "Draft a new release" (if you can't see this, you're not a core contribut or!)
168 3. Write human-friendly Release Notes based on changelog.
169 - The release title is "x.x.x / YYYY-MM-DD" (where x.x.x is the version number )
170 - If breaking changes, write migration tutorial(s) and reasoning.
171 - Callouts for community contributions (PRs) with links to PR and contributing user.
172 - Callouts for other fixes made by core contributors with links to issue.
173 4. Hit "Save Draft" and get other core contributors to check your work, or alter natively hit "Publish release"
174 5. That's it!
175
176 <a name="support"></a>
177 ## Support
178
179 <a name="resources"></a>
180 ### Resources
181
182 For most of the documentation you are going to want to visit [ChaiJS.com](http:/ /chaijs.com).
183
184 - [Getting Started Guide](http://chaijs.com/guide/)
185 - [API Reference](http://chaijs.com/api/)
186 - [Plugins](http://chaijs.com/plugins/)
187
188 Alternatively, the [wiki](https://github.com/chaijs/chai/wiki) might be what you are looking for.
189
190 - [Chai Coding Style Guide](https://github.com/chaijs/chai/wiki/Chai-Coding-Styl e-Guide)
191 - [Third-party Resources](https://github.com/chaijs/chai/wiki/Third-Party-Resour ces)
192
193 Or finally, you may find a core-contributor or like-minded developer in any of o ur support channels.
194
195 - IRC: irc.freenode.org #chaijs
196 - [Mailing List / Google Group](https://groups.google.com/forum/#!forum/chaijs)
197
198 <a name="contributors"></a>
199 ### Core Contributors
200
201 Feel free to reach out to any of the core-contributors with you questions or con cerns. We will do our best to respond in a timely manner.
202
203 - Jake Luer
204 - GH: [@logicalparadox](https://github.com/logicalparadox)
205 - TW: [@jakeluer](http://twitter.com/jakeluer)
206 - IRC: logicalparadox
207 - Veselin Todorov
208 - GH: [@vesln](https://github.com/vesln/)
209 - TW: [@vesln](http://twitter.com/vesln)
210 - IRC: vesln
211 - Keith Cirkel
212 - GH: [@keithamus](https://github.com/keithamus)
213 - TW: [@keithamus](http://twitter.com/keithamus)
214 - IRC: keithamus
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698