Ember is an open source project that succeeds thanks to the help of volunteers. Community members at any level are invited to help out with anything from bug reports to documentation. This guide will give you some tips on how to get started and where to ask for help if you want to get involved. Thanks in advance for your help!
Types of contributions
Any change that aims to make an improvement is very welcome!
You can create issues to document many things (list is not exhaustive!):
- Ideas for enhancements
- Code quality (e.g. refactoring)
- Improving the documentation (clarifying, rephrasing, providing more examples, fixing typos, adding missing details)
Creating an issue is a great way to start a discussion and gather opinions of other members of the Ember community. Once a decision has been made, you or someone else can volunteer to work on it, and create a pull request with their work.
Apart from creating new issues and pull requests, another way to contribute is comment on existing issues and pull requests. The more reviewers we get for something, the lower the chance we'll overlook potential problems.
Where to get started
A great place to start is helping improve something you personally ran into. E.g. if you found some of the documentation unclear yourself, please create an issue to highlight it, and optionally suggest how to simplify it.
Have a look at the list of main repositories to learn about the different components of the Ember project.
If you need some inspiration, you can check out the Help Wanted dashboard to browse for issues. If you are a beginner, look out for issues with the "Help wanted" and "Good first issue" labels.
Updating the API Guides
In the API Guides, suppose you found a typo or wish to provide more details for a package, method, or class. Here is how you can make a change.
At the top of the page (for the package, method, or class), you will find the words "Defined in" or "Inherited from". Next to these words is a link to the source code on GitHub.
You can open the link to find a comment block. Make a pull request to update the comment block. The API Guides may take a few weeks to update while the future release is finalized.
Here is an example of updating a method. At the top of the section for
store.createRecord(), you can find the words "Defined in."
Next to the words is, once again, the link to the source code
Please follow the contributing guide in the specific repo. (Here is an example of the contributing guide for Ember.js.) The contributing guide may further describe how you can edit files, commit messages, and run linting and testing.
Asking for help
Please comment directly on issues and PRs if you need help. This way others will see and can chime in to help.
You can also visit the Ember.js Community Page to join the Ember.js Discord server. Channels that start with
dev are for contributors working on the corresponding projects, and they are a great place for questions.
We would like to reiterate once again - anyone at any skill level can help out! If you have any ideas to improve anything whatsoever, we would love to see your contribution!