You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We would love for you to contribute to Nest and help make it even better than it is
3
+
We would love for you to contribute to NestJS Notify and help make it even better than it is
4
4
today! As a contributor, here are the guidelines we would like you to follow:
5
5
6
6
-[Code of Conduct](#coc)
@@ -10,244 +10,3 @@ today! As a contributor, here are the guidelines we would like you to follow:
10
10
-[Submission Guidelines](#submit)
11
11
-[Coding Rules](#rules)
12
12
-[Commit Message Guidelines](#commit)
13
-
<!-- - [Signing the CLA](#cla) -->
14
-
15
-
<!-- ## <a name="coc"></a> Code of Conduct
16
-
Help us keep Nest open and inclusive. Please read and follow our [Code of Conduct][coc]. -->
17
-
18
-
## <aname="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.** You've got much better chances of getting your question answered on [Stack Overflow](https://stackoverflow.com/questions/tagged/nestjs) where the questions should be tagged with tag `nestjs`.
21
-
22
-
Stack Overflow is a much better place to ask questions since:
23
-
24
-
<!-- - there are thousands of people willing to help on Stack Overflow [maybe one day] -->
25
-
- questions and answers stay available for public viewing so your question / answer might help someone else
26
-
- Stack Overflow's voting system assures that the best answers are prominently visible.
27
-
28
-
To save your and our time, we will systematically close all issues that are requests for general support and redirect people to Stack Overflow.
29
-
30
-
If you would like to chat about the question in real-time, you can reach out via [our gitter channel][gitter].
31
-
32
-
## <aname="issue"></a> Found a Bug?
33
-
If you find a bug in the source code, you can help us by
34
-
[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can
35
-
[submit a Pull Request](#submit-pr) with a fix.
36
-
37
-
## <aname="feature"></a> Missing a Feature?
38
-
You can *request* a new feature by [submitting an issue](#submit-issue) to our GitHub
39
-
Repository. If you would like to *implement* a new feature, please submit an issue with
40
-
a proposal for your work first, to be sure that we can use it.
41
-
Please consider what kind of change it is:
42
-
43
-
* For a **Major Feature**, first open an issue and outline your proposal so that it can be
44
-
discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
45
-
and help you to craft the change so that it is successfully accepted into the project. For your issue name, please prefix your proposal with `[discussion]`, for example "[discussion]: your feature idea".
46
-
***Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
47
-
48
-
## <aname="submit"></a> Submission Guidelines
49
-
50
-
### <aname="submit-issue"></a> Submitting an Issue
51
-
52
-
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.
53
-
54
-
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario using a repository or [Gist](https://gist.github.com/). Having a live, reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like:
55
-
56
-
- version of NestJS used
57
-
- 3rd-party libraries and their versions
58
-
- and most importantly - a use-case that fails
59
-
60
-
<!--
61
-
// TODO we need to create a playground, similar to plunkr
62
-
63
-
A minimal reproduce scenario using a repository or Gist allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem. If neither of these are not a suitable way to demonstrate the problem (for example for issues related to our npm packaging), please create a standalone git repository demonstrating the problem. -->
64
-
65
-
<!-- We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal plunk. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it. -->
66
-
67
-
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 don't have enough info to be reproduced.
68
-
69
-
You can file new issues by filling out our [new issue form](https://github.com/nestjs/nest/issues/new).
70
-
71
-
72
-
### <aname="submit-pr"></a> Submitting a Pull Request (PR)
73
-
Before you submit your Pull Request (PR) consider the following guidelines:
74
-
75
-
1. Search [GitHub](https://github.com/nestjs/nest/pulls) for an open or closed PR
76
-
that relates to your submission. You don't want to duplicate effort.
We have very precise rules over how our git commit messages can be formatted. This leads to **more
161
-
readable messages** that are easy to follow when looking through the **project history**. But also,
162
-
we use the git commit messages to **generate the Nest change log**.
163
-
164
-
### Commit Message Format
165
-
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
166
-
format that includes a **type**, a **scope** and a **subject**:
167
-
168
-
```
169
-
<type>(<scope>): <subject>
170
-
<BLANK LINE>
171
-
<body>
172
-
<BLANK LINE>
173
-
<footer>
174
-
```
175
-
176
-
The **header** is mandatory and the **scope** of the header is optional.
177
-
178
-
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
179
-
to read on GitHub as well as in various git tools.
180
-
181
-
Footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
182
-
183
-
Samples: (even more [samples](https://github.com/nestjs/nest/commits/master))
184
-
185
-
```
186
-
docs(changelog) update change log to beta.5
187
-
```
188
-
```
189
-
fix(@nestjs/core) need to depend on latest rxjs and zone.js
190
-
191
-
The version in our package.json gets copied to the one we publish, and users need the latest of these.
192
-
```
193
-
194
-
### Revert
195
-
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
196
-
197
-
### Type
198
-
Must be one of the following:
199
-
200
-
* **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
201
-
* **chore**: Updating tasks etc; no production code change
202
-
* **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
203
-
* **docs**: Documentation only changes
204
-
* **feat**: A new feature
205
-
* **fix**: A bug fix
206
-
* **perf**: A code change that improves performance
207
-
* **refactor**: A code change that neither fixes a bug nor adds a feature
208
-
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
209
-
* **test**: Adding missing tests or correcting existing tests
210
-
211
-
212
-
### Subject
213
-
The subject contains succinct description of the change:
214
-
215
-
* use the imperative, present tense: "change" not "changed" nor "changes"
216
-
* don't capitalize first letter
217
-
* no dot (.) at the end
218
-
219
-
### Body
220
-
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
221
-
The body should include the motivation for the change and contrast this with previous behavior.
222
-
223
-
### Footer
224
-
The footer should contain any information about **Breaking Changes** and is also the place to
225
-
reference GitHub issues that this commit **Closes**.
226
-
227
-
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
228
-
229
-
A detailed explanation can be found in this [document][commit-message-format].
230
-
231
-
<!-- ## <a name="cla"></a> Signing the CLA
232
-
233
-
Please sign our Contributor License Agreement (CLA) before sending pull requests. For any code
234
-
changes to be accepted, the CLA must be signed. It's a quick process, we promise!
235
-
236
-
* For individuals we have a [simple click-through form][individual-cla].
237
-
* For corporations we'll need you to
238
-
[print, sign and one of scan+email, fax or mail the form][corporate-cla]. -->
0 commit comments