Skip to content

Commit 0214964

Browse files
committed
docs(CONTRIBUTING): add GitHub Issue and PR template
Also about checklist to include new operators Fixes issues #1355 and #1429
1 parent bcfee80 commit 0214964

File tree

3 files changed

+53
-1
lines changed

3 files changed

+53
-1
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!--
2+
Thank you for raising your concerns, we appreciate your feedback and contributions to this repository.
3+
4+
Before you continue, consider the following:
5+
6+
If you have a "How do I do ...?" question, it is better for you and for us that this question is placed in [StackOverflow](http://stackoverflow.com/questions/tagged/rxjs) or some chat channel. This way, you are making it easier for others to learn from your experiences too.
7+
8+
These "Issues" are meant only for technical problems, bugs, and proposals related to the library.
9+
10+
If your issue is a bug, please follow the format below:
11+
-->
12+
13+
**What version of RxJS I am using:**
14+
15+
**What is happening:**
16+
17+
**Code snippet to reproduce it:**
18+
19+
**What should happen instead:**
20+
21+
**Other support information or links:**

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!--
2+
Thank you very much for your pull request!
3+
4+
If your PR is the addition of a new operator, please make sure all these boxes are ticked with an x:
5+
6+
- [ ] Add the operator to either Core or KitchenSink
7+
- [ ] It should have a `-spec.ts` tests file covering the canonical corner cases, with marble diagram tests
8+
- [ ] It should have a `asDiagram` test case too, if possible
9+
- [ ] It Should have a type definition test at the end of the spec to verify type definition for various use cases
10+
- [ ] Should have documentation in JSDoc style, including also the PNG marble diagram image
11+
- [ ] Should be listed in `doc/operators.md` in a category of operators
12+
- [ ] Should be put in the operator decision tree file `doc/decision-tree-widget/tree.yml`
13+
- [ ] Update `MIGRATION.md` if it covers migration from RxJS v4 to this version
14+
-->
15+
16+
**Description:**
17+
18+
**Related issue (if exists):**

doc/operator-creation.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,20 @@ There are a few things to know and (try to) understand while developing operator
128128
the shared underlying subscription.
129129
- When you `subscribe` to an Observable, the functions or Observer you passed are used to create the final `destination`
130130
`Subscriber` for the chain. It's this `Subscriber` that is really also the shared `Subscriptoin` for the operator chain.
131-
131+
132+
### Submitting a PR for an Operator
133+
134+
Please complete these steps for each new operator added to RxJS as a pull request:
135+
136+
- Add the operator to either Core or KitchenSink
137+
- It should have a `-spec.ts` tests file covering the canonical corner cases, with marble diagram tests
138+
- It should have a `asDiagram` test case too, if possible
139+
- It Should have a type definition test at the end of the spec to verify type definition for various use cases
140+
- Should have documentation in JSDoc style, including also the PNG marble diagram image
141+
- Should be listed in `doc/operators.md` in a category of operators
142+
- Should be put in the operator decision tree file `doc/decision-tree-widget/tree.yml`
143+
- Update `MIGRATION.md` if it covers migration from RxJS v4 to this version
144+
132145
### Inner Subscriptions
133146

134147
An "inner subscriber" or "inner subscription" is any subscription created inside of an operator's primary Subscriber. For example,

0 commit comments

Comments
 (0)