Skip to content
This repository was archived by the owner on Oct 1, 2018. It is now read-only.

Commit eef6095

Browse files
author
Jennifer Luker
committed
docs(README.md): add references to external content
add reference to code of conduct and new contributing file none
1 parent 2c533f9 commit eef6095

File tree

2 files changed

+175
-0
lines changed

2 files changed

+175
-0
lines changed

‎CONTRIBUTING.md‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
# Contributing to RxJS
2+
3+
[Read and abide by the Code of Conduct](CODE_OF_CONDUCT.md)! Even if you don't read it,
4+
it still applies to you. Ignorance is not an exemption.
5+
6+
Contents
7+
8+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
9+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
10+
11+
- [Submitting a Pull Request (PR)](#submitting-a-pull-request-pr)
12+
- [After your pull request is merged](#after-your-pull-request-is-merged)
13+
- [Commit Message Guidelines](#commit-message-guidelines)
14+
- [Commit Message Format](#commit-message-format)
15+
- [Revert](#revert)
16+
- [Type](#type)
17+
- [Scope](#scope)
18+
- [Subject](#subject)
19+
- [Body](#body)
20+
- [Footer](#footer)
21+
22+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
23+
24+
(This document is a work and progress and is subject to change)
25+
26+
## Submitting a Pull Request (PR)
27+
Before you submit your Pull Request (PR) consider the following guidelines:
28+
29+
* Search [GitHub](https://github.com/ReactiveX/rxjs-docs/pulls) for an open or closed PR
30+
that relates to your submission. You don't want to duplicate effort.
31+
* Make your changes in a new git branch:
32+
33+
```shell
34+
git checkout -b my-fix-branch master
35+
```
36+
37+
* Create your patch, following [code style guidelines](#coding-style-guidelines), and **including appropriate test cases**.
38+
* Run the full test suite and ensure that all tests pass.
39+
* Run the micro and macro performance tests against your feature branch and compare against master
40+
to ensure performance wasn't changed for the worse.
41+
* Commit your changes using a descriptive commit message that follows our
42+
[commit message guidelines](#commit-message-guidelines). Adherence to these conventions
43+
is necessary because release notes are automatically generated from these messages.
44+
45+
```shell
46+
git commit -a
47+
```
48+
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
49+
50+
* Push your branch to GitHub:
51+
52+
```shell
53+
git push origin my-fix-branch
54+
```
55+
56+
* In GitHub, send a pull request to `rxjs-docs:master`.
57+
* If we suggest changes then:
58+
* Make the required updates.
59+
* Re-run the test suites to ensure tests are still passing.
60+
* Re-run performance tests to make sure your changes didn't hurt performance.
61+
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
62+
63+
```shell
64+
git rebase master -i
65+
git push -f
66+
```
67+
68+
That's it! Thank you for your contribution!
69+
70+
71+
### After your pull request is merged
72+
73+
After your pull request is merged, you can safely delete your branch and pull the changes
74+
from the main (upstream) repository:
75+
76+
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
77+
78+
```shell
79+
git push origin --delete my-fix-branch
80+
```
81+
82+
* Check out the master branch:
83+
84+
```shell
85+
git checkout master -f
86+
```
87+
88+
* Delete the local branch:
89+
90+
```shell
91+
git branch -D my-fix-branch
92+
```
93+
94+
* Update your master with the latest upstream version:
95+
96+
```shell
97+
git pull --ff upstream master
98+
```
99+
100+
101+
- [Submitting a Pull Request (PR)](#submitting-a-pull-request-pr)
102+
## Commit Message Guidelines
103+
104+
We have very precise rules over how our git commit messages can be formatted. This leads to **more
105+
readable messages** that are easy to follow when looking through the **project history**. But also,
106+
we use the git commit messages to **generate the rxjs-docs change log**. Helper script `npm run commit`
107+
provides command line based wizard to format commit message easily.
108+
109+
### Commit Message Format
110+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
111+
format that includes a **type**, a **scope** and a **subject**:
112+
113+
```
114+
<type>(<scope>): <subject>
115+
<BLANK LINE>
116+
<body>
117+
<BLANK LINE>
118+
<footer>
119+
```
120+
121+
The **header** is mandatory and the **scope** of the header is optional.
122+
123+
Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier
124+
to read on GitHub as well as in various git tools.
125+
126+
### Revert
127+
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.
128+
129+
### Type
130+
Must be one of the following:
131+
132+
* **feat**: A new feature
133+
* **fix**: A bug fix
134+
* **docs**: Documentation only changes
135+
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
136+
semi-colons, etc)
137+
* **refactor**: A code change that neither fixes a bug nor adds a feature
138+
* **perf**: A code change that improves performance
139+
* **test**: Adding missing tests
140+
* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
141+
generation
142+
143+
### Scope
144+
The scope could be anything specifying place of the commit change. For example
145+
`Observable`, `Subject`, `switchMap`, etc.
146+
147+
### Subject
148+
The subject contains succinct description of the change:
149+
150+
* use the imperative, present tense: "change" not "changed" nor "changes"
151+
* don't capitalize first letter
152+
* no dot (.) at the end
153+
154+
### Body
155+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
156+
The body should include the motivation for the change and contrast this with previous behavior.
157+
158+
### Footer
159+
The footer should contain any information about **Breaking Changes** and is also the place to
160+
reference GitHub issues that this commit **Closes**.
161+
162+
**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.

‎README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
1+
[![Build Status](https://travis-ci.org/ReactiveX/rxjs-docs.svg?branch=master)](https://travis-ci.org/ReactiveX/rxjs)
2+
[![Coverage Status](https://coveralls.io/repos/github/ReactiveX/rxjs-docs/badge.svg?branch=master)](https://coveralls.io/github/ReactiveX/rxjs?branch=master)
3+
[![npm version](https://badge.fury.io/js/%40reactivex%2Frxjs-docs.svg)](http://badge.fury.io/js/%40reactivex%2Frxjs)
4+
15
# rxjs-docs
26
The home for new work on the new RxJS docs (RxJS v5 and up)
37

8+
9+
- [Code of Conduct](CODE_OF_CONDUCT.md)
10+
- [Contribution Guidelines](CONTRIBUTING.md)
11+
- [Maintainer Guidelines](doc/maintainer-guidelines.md)
12+
- [Creating Operators](doc/operator-creation.md)
13+
- [Migrating From RxJS 4 to RxJS 5](MIGRATION.md)
14+
- [API Documentation (WIP)](http://reactivex.io/rxjs)
15+
16+
417
## Initial setup
518

619
Run `yarn install`

0 commit comments

Comments
 (0)