|
1 | | -## Contributing to Meteor |
| 1 | +### Contributing to Meteor |
2 | 2 |
|
3 | | -We hope you will join us in building Meteor -- both the platform and the |
4 | | -community behind it -- and share in the rewards of getting in early on |
5 | | -something great. |
| 3 | +Thank you for contributing to the Meteor project! |
6 | 4 |
|
7 | | -Please see our |
| 5 | +Before you file a bug or pull request, please read our |
8 | 6 | [contributing guidelines](https://github.com/meteor/meteor/wiki/Contributing-to-Meteor) |
9 | 7 | on GitHub for more details on how to file a bug report or submit a |
10 | 8 | pull request. |
11 | 9 |
|
12 | | -### Bug reports |
13 | | - |
14 | | -If you've found a bug in Meteor that isn't a security risk, you can file |
15 | | -a report in |
16 | | -[our issue tracker](https://github.com/meteor/meteor/issues). |
17 | | - |
18 | | -> There is a separate procedure for security-related issues. If the |
19 | | -> issue you've found contains sensitive information or raises a security |
20 | | -> concern, email <code>security[]()@[]()meteor.com</code> instead, which |
21 | | -> will page the security team. |
22 | | -
|
23 | | -Please don't use GitHub issues for feature requests or proposals. Most |
24 | | -additions deserve a fair bit of discussion, which doesn't work super |
25 | | -well inside a GitHub issue. Read on for how to get changes into Meteor. |
26 | | - |
27 | | -A Meteor app has many moving parts, and it's often difficult to |
28 | | -reproduce a bug based on just a few lines of code. So your report |
29 | | -should include a reproduction recipe. By making it as easy as possible |
30 | | -for others to reproduce your bug, you make it easier for your bug to be |
31 | | -fixed. **We may not be able to tackle an issue opened without a |
32 | | -reproduction recipe. If we can't, we'll close them it a pointer to this |
33 | | -wiki section and a request for more information.** |
34 | | - |
35 | | -A reproduction recipe works like this: |
36 | | - |
37 | | - * Create a new Meteor app that displays the bug with as little code as |
38 | | - possible. Try to delete any code that is unrelated to the precise bug |
39 | | - you're reporting, including extraneous Atmosphere packages. |
40 | | - |
41 | | - * Create a new GitHub repository with a name like |
42 | | - `meteor-reactivity-bug` (or if you're adding a new reproduction |
43 | | - recipe to an existing issue, `meteor-issue-321`) and push your code |
44 | | - to it. (Make sure to include the `.meteor/packages` and `.meteor/release` files!) |
45 | | - |
46 | | - * Reproduce the bug from scratch, starting with a `git clone` |
47 | | - command. Copy and paste the entire command-line input and output, |
48 | | - starting with the `git clone` command, into the issue description of |
49 | | - a new GitHub issue. Also describe any web browser interaction you |
50 | | - need to do. |
51 | | - |
52 | | - * If you reproduced the issue using a checkout of Meteor instead of using |
53 | | - a released version that was pinned with a `.meteor/release` file, |
54 | | - specify what commit in the Meteor repository was checked out. |
55 | | - |
56 | | -If you want to submit a pull request that fixes your bug, that's even |
57 | | -better. We love getting bugfix pull requests. Just make sure they're |
58 | | -written to the MDG style guide and *come with tests*. Read further down |
59 | | -for more details on proposing changes to core code. |
60 | | - |
61 | | -### Pull requests |
62 | | - |
63 | | -Before submitting a pull request, please read the |
64 | | -[contributing guidelines](https://github.com/meteor/meteor/wiki/Contributing-to-Meteor) |
65 | | -on GitHub. In brief: |
66 | | - |
67 | | -* If possible, publish new features as separate packages on |
68 | | - [Atmosphere](https://atmosphere.meteor.com). |
69 | | - |
70 | | -* Most changes to core packages should be discussed first on |
71 | | - [`meteor-core`](https://groups.google.com/group/meteor-core), where |
72 | | - you can build consensus and work out most of the design. Submit a |
73 | | - pull request once you have a core developer on board. |
74 | | - |
75 | | -* The `meteor-core` list is also a fine place to request new features |
76 | | - without a specific proposal. GitHub issues aren't as good place for |
77 | | - those that sort of thing: we'll close "feature request" issues. |
| 10 | +*Please do not file security issues in the GitHub issue tracker.* If |
| 11 | +the issue you've found |
| 12 | +contains sensitive information or raises a security concern, email |
| 13 | +<code>security[]()@[]()meteor.com</code> instead, which will page the |
| 14 | +security team. |
0 commit comments