Skip to content

Commit ce7505d

Browse files
committed
Contributing - be more explicit about requirements
1 parent 602e9dc commit ce7505d

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

Contributing.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ All packages are under the main repo. To clone the dev environment:
66

77
```bash
88
$ git clone -b v2 https://github.com/gadicc/meteor-messageformat.git
9-
$ cd meteor-messageformat
9+
$ cd meteor-messageformat
1010
```
1111

1212
This directory now contains the repo base dir (README, etc), `msgfmt:core`, `msgfmt:ui`,
@@ -36,6 +36,24 @@ and open a browser to http://localhost:3002/.
3636
1. Create your new code
3737
1. Confirm that your test now passes
3838

39+
## Pull Request Requirements
40+
41+
We greatly appreciate help with this project but we have a few requirements
42+
to ensure smooth development.
43+
44+
1. **Keep your PR as simple and concise as possible**. *Do not mix multiple
45+
**unrelated** features/fixes into a single PR.* It is almost always
46+
impossible for us to accept PRs that ignore this rule. To submit multiple PRs,
47+
simply use a different *branch* for each feature. This is common practice
48+
everywhere. e.g. `git checkout -b faster-loads` (see also the GitHub
49+
pull request doc linked below).
50+
51+
1. **All PRs should contain a test, that what would have failed before your
52+
change and passes after (see above)**. If there's no existing test that you
53+
can copy, paste and modify to test for your work, and you don't feel
54+
comfortable writing your own, it's ok, but then please state this when
55+
submitting.
56+
3957
## Contributing your change (Pull Requests)
4058

4159
Please see https://help.github.com/articles/using-pull-requests/.

0 commit comments

Comments
 (0)