Skip to content

Commit fbf2633

Browse files
committed
chore(CONTRIBUTING.md): Add instructions on how to pubish redux-observable to npm
1 parent 27a0019 commit fbf2633

File tree

1 file changed

+51
-49
lines changed

1 file changed

+51
-49
lines changed

CONTRIBUTING.md

+51-49
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,37 @@ On both websites, it is a good idea to structure your code and question in a way
2626

2727
Please keep in mind that people spend their free time trying to help you. You can make it easier for them if you provide versions of the relevant libraries and a runnable small project reproducing your issue. You can put your code on [JSBin](http://jsbin.com) or, for bigger projects, on GitHub. Make sure all the necessary dependencies are declared in `package.json` so anyone can run `npm install && npm start` and reproduce your issue.
2828

29+
### Sending a Pull Request
30+
31+
For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work. We don’t want you to waste your efforts on a pull request that we won’t want to accept.
32+
33+
On the other hand, sometimes the best way to start a conversation *is* to send a pull request. Use your best judgment!
34+
35+
In general, the contribution workflow looks like this:
36+
37+
* Open a new issue in the [Issue tracker](https://github.com/redux-observable/redux-observable/issues).
38+
* Fork the repo.
39+
* Create a new feature branch based off the `master` branch.
40+
* Make sure all tests pass and there are no linting errors.
41+
* Submit a pull request, referencing any issues it addresses.
42+
43+
**Commit messages should follow the [conventional-changelog-standard](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md).** (the same used by [RxJS](https://github.com/ReactiveX/rxjs) and [Angular 2](https://github.com/angular/angular))
44+
45+
e.g.
46+
47+
```
48+
fix(actions): Emit actions to ActionsSubject recursively9
49+
50+
Closes #1528
51+
```
52+
53+
Please try to keep your pull request focused in scope and avoid including unrelated commits.
54+
55+
After you have submitted your pull request, we’ll try to get back to you as soon as possible. We may suggest some changes or improvements.
56+
57+
Thank you for contributing!
58+
59+
2960
## Development
3061

3162
Visit the [issue tracker](https://github.com/redux-observable/redux-observable/issues) to find a list of open issues that need attention.
@@ -81,6 +112,26 @@ To only run tests:
81112
npm run test
82113
```
83114

115+
### Publishing to NPM
116+
117+
There are several tasks needed to publish a new version, but thankfully we automate all of them into a single command:
118+
119+
```
120+
npm run shipit
121+
```
122+
123+
This will:
124+
125+
* Confirm passing linting and tests
126+
* Prompt you for the new version number to publish
127+
* Bump package.json with that new number
128+
* Generate CHANGELOG.md
129+
* Commit those changes to package.json and CHANGELOG.md
130+
* Push a tag of this release
131+
* And finally publish to NPM
132+
133+
_Using this command when you do not have all the required permissions is unsupported and probably has unexpected behavior._
134+
84135
### Docs
85136

86137
Improvements to the documentation are always welcome. In the docs we abide by typographic rules, so instead of ' you should use ’. Same goes for “ ” and dashes (—) where appropriate. These rules only apply to the text, not to code blocks.
@@ -124,52 +175,3 @@ To remove previously built documentation, run the following:
124175
```
125176
npm run docs:clean
126177
```
127-
128-
### Examples
129-
130-
redux-observable comes with [official examples](http://redux-observable.js.org/docs/introduction/Examples) to demonstrate various concepts and best practices.
131-
132-
When adding a new example, please adhere to the style and format of the existing examples, and try to reuse as much code as possible. For example, `index.html`, `server.js`, and `webpack.config.js` can typically be reused.
133-
134-
#### Building and Testing the Examples
135-
136-
To build and test the official redux-observable examples, run the following:
137-
138-
```
139-
npm run build:examples
140-
npm run test:examples
141-
```
142-
143-
Not all examples have tests. If you see an example project without tests, you are very welcome to add them in a way consistent with the examples that have tests.
144-
145-
Please visit the [Examples page](http://redux-observable.js.org/docs/introduction/Examples.html) for information on running individual examples.
146-
147-
### Sending a Pull Request
148-
149-
For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work. We don’t want you to waste your efforts on a pull request that we won’t want to accept.
150-
151-
On the other hand, sometimes the best way to start a conversation *is* to send a pull request. Use your best judgement!
152-
153-
In general, the contribution workflow looks like this:
154-
155-
* Open a new issue in the [Issue tracker](https://github.com/redux-observable/redux-observable/issues).
156-
* Fork the repo.
157-
* Create a new feature branch based off the `master` branch.
158-
* Make sure all tests pass and there are no linting errors.
159-
* Submit a pull request, referencing any issues it addresses.
160-
161-
**Commit messages should follow the [conventional-changelog-standard](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md).** (the same used by [RxJS](https://github.com/ReactiveX/rxjs) and [Angular 2](https://github.com/angular/angular))
162-
163-
e.g.
164-
165-
```
166-
fix(actions): Emit actions to ActionsSubject recursively9
167-
168-
Closes #1528
169-
```
170-
171-
Please try to keep your pull request focused in scope and avoid including unrelated commits.
172-
173-
After you have submitted your pull request, we’ll try to get back to you as soon as possible. We may suggest some changes or improvements.
174-
175-
Thank you for contributing!

0 commit comments

Comments
 (0)