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

Side by Side Diff: test/js_test_tools/chai/CONTRIBUTING.md

Issue 1243503007: fixes #221, initial sync*, async, async* implementation (Closed) Base URL: git@github.com:dart-lang/dev_compiler.git@master
Patch Set: Created 5 years, 4 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
« no previous file with comments | « test/js_test_tools/chai/.bower.json ('k') | test/js_test_tools/chai/History.md » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
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 - [Support](#support)
15 - [Resources](#resources)
16 - [Core Contributors](#contributors)
17
18 <a name="tldr"></a>
19 ## TLDR;
20
21 - Creating an Issue or Pull Request requires a [GitHub](http://github.com) accou nt.
22 - 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) .
23 - Pull Requests must adhere to strict [coding style guidelines](https://github.c om/chaijs/chai/wiki/Chai-Coding-Style-Guide).
24 - 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.
25 - Additional support is available via the [Google Group](http://groups.google.co m/group/chaijs) or on irc.freenode.net#chaijs.
26 - **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.
27
28
29
30 <a name="contributing"></a>
31 ## Contributing
32
33 The issue tracker is the preferred channel for [bug reports](#bugs),
34 [feature requests](#features) and [submitting pull
35 requests](#pull-requests), but please respect the following restrictions:
36
37 * Please **do not** use the issue tracker for personal support requests (use
38 [Google Group](https://groups.google.com/forum/#!forum/chaijs) or IRC).
39 * Please **do not** derail or troll issues. Keep the discussion on topic and
40 respect the opinions of others
41
42 <a name="bugs"></a>
43 ### Bug Reports
44
45 A bug is a **demonstrable problem** that is caused by the code in the repository .
46
47 Guidelines for bug reports:
48
49 1. **Use the GitHub issue search** &mdash; check if the issue has already been r eported.
50 2. **Check if the issue has been fixed** &mdash; try to reproduce it using the l atest `master` or development branch in the repository.
51 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.
52
53 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.
54
55 Example:
56
57 > Short and descriptive example bug report title
58 >
59 > 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.
60 >
61 > 1. This is the first step
62 > 2. This is the second step
63 > 3. Further steps, etc.
64 >
65 > `<url>` - a link to the reduced test case OR
66 > ```js
67 > expect(a).to.equal('a');
68 > // code sample
69 > ```
70 >
71 > 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).
72
73 <a name="features"></a>
74 ### Feature Requests
75
76 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.
77
78 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).
79
80 <a name="pull-requests"></a>
81 ### Pull Requests
82
83 - PRs for new core-assertions are advised against.
84 - PRs for core-assertion bug fixes are always welcome.
85 - PRs for enhancing the interfaces are always welcome.
86 - PRs that increase test coverage are always welcome.
87 - PRs are scrutinized for coding-style.
88
89 Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
90
91 **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.
92
93 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).
94
95 Follow this process if you'd like your work considered for inclusion in the proj ect:
96
97 1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes:
98
99 ```bash
100 # Clone your fork of the repo into the current directory
101 git clone https://github.com/<your-username>/<repo-name>
102 # Navigate to the newly cloned directory
103 cd <repo-name>
104 # Assign the original repo to a remote called "upstream"
105 git remote add upstream https://github.com/<upstream-owner>/<repo-name>
106 ```
107
108 2. If you cloned a while ago, get the latest changes from upstream:
109
110 ```bash
111 git checkout <dev-branch>
112 git pull upstream <dev-branch>
113 ```
114
115 3. Create a new topic branch (off the main project development branch) to contai n your feature, change, or fix:
116
117 ```bash
118 git checkout -b <topic-branch-name>
119 ```
120
121 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.
122
123 5. Locally merge (or rebase) the upstream development branch into your topic bra nch:
124
125 ```bash
126 git pull [--rebase] upstream <dev-branch>
127 ```
128
129 6. Push your topic branch up to your fork:
130
131 ```bash
132 git push origin <topic-branch-name>
133 ```
134
135 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description.
136
137 **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.
138
139 <a name="support"></a>
140 ## Support
141
142 <a name="resources"></a>
143 ### Resources
144
145 For most of the documentation you are going to want to visit [ChaiJS.com](http:/ /chaijs.com).
146
147 - [Getting Started Guide](http://chaijs.com/guide/)
148 - [API Reference](http://chaijs.com/api/)
149 - [Plugins](http://chaijs.com/plugins/)
150
151 Alternatively, the [wiki](https://github.com/chaijs/chai/wiki) might be what you are looking for.
152
153 - [Chai Coding Style Guide](https://github.com/chaijs/chai/wiki/Chai-Coding-Styl e-Guide)
154 - [Third-party Resources](https://github.com/chaijs/chai/wiki/Third-Party-Resour ces)
155
156 Or finally, you may find a core-contributor or like-minded developer in any of o ur support channels.
157
158 - IRC: irc.freenode.org #chaijs
159 - [Mailing List / Google Group](https://groups.google.com/forum/#!forum/chaijs)
160
161 <a name="contributors"></a>
162 ### Core Contributors
163
164 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.
165
166 - Jake Luer
167 - GH: [@logicalparadox](https://github.com/logicalparadox)
168 - TW: [@jakeluer](http://twitter.com/jakeluer)
169 - IRC: logicalparadox
170 - Veselin Todorov
171 - GH: [@vesln](https://github.com/vesln/)
172 - TW: [@vesln](http://twitter.com/vesln)
173 - IRC: vesln
OLDNEW
« no previous file with comments | « test/js_test_tools/chai/.bower.json ('k') | test/js_test_tools/chai/History.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698