mirror of
https://github.com/meteor/meteor.git
synced 2026-05-02 03:01:46 -04:00
Add project overview section to Contributing.md
Expanding on ways to contribute and project roles
This commit is contained in:
@@ -1,10 +1,84 @@
|
||||
# Contributing to Meteor
|
||||
|
||||
Thank you for contributing to the Meteor project! Please read the guidelines below or it might be
|
||||
hard for the community to help you with your issue or pull request.
|
||||
We are excited to have your help building Meteor — both the platform and the community behind it. Please read the project overview and guidelines for contributing bug reports and new code, or it might be hard for the community to help you with your issue or pull request.
|
||||
|
||||
We are excited to have your help building Meteor — both the platform and the
|
||||
community behind it. Here's how you can help with bug reports and new code.
|
||||
<h2 id="project-overview">Project overview</h2>
|
||||
|
||||
Before we jump into detailed guidelines for opening and triaging issues and submitting pull requests, here is some information about how our project is structured and resources you should refer to as you start contributing.
|
||||
|
||||
### Ways to contribute
|
||||
|
||||
There are many ways to contribute to the Meteor Project. Here’s a list of technical contributions with increasing levels of involvement and required knowledge of Meteor’s code and operations.
|
||||
- [Reporting a bug](https://github.com/meteor/meteor/blob/devel/Contributing.md#reporting-a-bug-in-meteor)
|
||||
- [Triaging issues](https://github.com/meteor/meteor/blob/devel/IssueTriage.md)
|
||||
- [Contributing to documentation](https://github.com/meteor/docs/blob/master/Contributing.md)
|
||||
- [Submitting pull requests](https://github.com/meteor/meteor/blob/devel/Contributing.md#making-changes-to-meteor-core)
|
||||
- Reviewing pull requests
|
||||
- Maintaining a community package
|
||||
|
||||
There are also several ways to contribute to the Meteor Project outside of GitHub, like organizing or speaking at [Meetups](https://www.meetup.com/topics/meteor/) and events and helping to moderate our [forums](https://forums.meteor.com/). Stay tuned for more documentation around non-code contributions.
|
||||
|
||||
If you can think of any changes to the project or documentation that would improve the contributor experience, let us know by opening an issue!
|
||||
|
||||
### Project roles
|
||||
|
||||
We’ve just begun to create more defined project roles for Meteor. Here are descriptions of the existing project roles, along with the current contributors taking on those roles today.
|
||||
|
||||
#### Issue Triager
|
||||
|
||||
Issue Triagers are members of the community that meet with us weekly to help triage Meteor’s open issues and bug reports. Once you’ve begun triaging issues regularly on your own, we will invite you to join our dedicated Slack channel to participate in these regular coordination sessions.
|
||||
|
||||
Current Issue Triagers:
|
||||
- [@hwillson](https://github.com/hwillson)
|
||||
- [@laosb](https://github.com/laosb)
|
||||
- [@abernix](https://github.com/abernix)
|
||||
- [@lorensr](https://github.com/lorensr)
|
||||
|
||||
#### Reviewer
|
||||
|
||||
Our most regular and experienced Issue Triagers sometimes move on to doing code reviews for pull requests, and have input into which pull requests should be merged.
|
||||
|
||||
Current Reviewers:
|
||||
- [@lorensr](https://github.com/lorensr)
|
||||
- [@abernix](https://github.com/abernix)
|
||||
|
||||
#### Core Committer
|
||||
|
||||
For now, the only contributors with commit access to meteor/meteor are employees of Meteor Development Group, the company that sponsors the Meteor project. We're actively exploring adding non-MDG core committers who have distinguished themselves in other contribution areas.
|
||||
|
||||
Project Lead: [@benjamn](https://github.com/benjamn)
|
||||
|
||||
Current Core Committers:
|
||||
- [@tmeasday](https://github.com/tmeasday)
|
||||
- [@zol](https://github.com/zol)
|
||||
- [@glasser](https://github.com/glasser)
|
||||
- [@stubailo](https://github.com/stubailo)
|
||||
|
||||
#### Documentation Maintainer
|
||||
|
||||
Documentation Maintainers are regular documentation contributors that have been given the ability to merge docs changes on [meteor/docs](https://github.com/meteor/docs).
|
||||
|
||||
Current Documentation Maintainers:
|
||||
- [@tmeasday](https://github.com/tmeasday)
|
||||
- [@lorensr](https://github.com/lorensr)
|
||||
|
||||
#### Community Package Maintainer:
|
||||
|
||||
Community package maintainers are community members who maintain packages outside of Meteor core. This requires code to be extracted from meteor/meteor, and entails a high level of responsibility. For this reason, community maintainers generally (and currently) must first become an advanced contributor to Meteor core and have 4-5 non-trivial pull requests merged that went through the proper contribution workflow. At that point, core contributors may make the case for breaking out a particular core package, and assist in the technical process around doing so.
|
||||
|
||||
Current Community Package Maintainers:
|
||||
- @mitar for [Blaze](https://github.com/meteor/blaze)
|
||||
|
||||
#### Community Manager
|
||||
|
||||
The community manager helps to coordinate resources, documentation, events, and other supportive work needed to ensure the health of the Meteor project.
|
||||
|
||||
Current Community Manager:
|
||||
- @theadactyl
|
||||
|
||||
### Tracking project work
|
||||
|
||||
Right now, the best place to track the work being done on Meteor is to take a look at the latest release milestone [here](https://github.com/meteor/meteor/milestones). We also curate specific issues that would make great pull requests from the community with the [pull requests encouraged tag](https://github.com/meteor/meteor/issues?q=is%3Aopen+is%3Aissue+label%3Apull-requests-encouraged).
|
||||
|
||||
<h2 id="reporting-bug">Reporting a bug in Meteor</h2>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user