Skip to content

Latest commit

 

History

History
29 lines (25 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

29 lines (25 loc) · 1.68 KB

CONTRIBUTING

Ember Developer Guide

Welcome to Ember Contributing Guidelines. Follow these when you are thinking about contributing to Ember project. We welcome your contributions to Ember!

Quick Reference

Here are the basic steps needed to get set up and contribute a patch.

  1. Install and set up Git.
  2. Fork the Ember repository to your GitHub account and get the source code using:
git clone --recursive https://github.com/<your_username>/Ember.git
cd Ember

  1. Windows users can run the GenerateProjects.bat to generate project files.

    If you are getting errors, make sure you cloned the repo using --recurse option. If you are still getting errors (might because you are using an old git version), run git submodule init and git submodule update in the ember directory, and see if that resolves your issue, otherwise you can open an issue providing your git logs.

  2. Open the generated Ember.sln in Visual Studio.

  3. Create a new branch where your work for the issue will go, format it fix-issue-#, e.g.:

    git checkout -b fix-issue-12345 master

    If an issue does not already exist, please create it. Trivial issues (e.g. typo fixes) do not require any issue to be created.

  4. Once you fixed the issue, try building the solution, and check no errors are occuring, if everything is ok, commit.

  5. Push the branch on your fork on GitHub and create a pull request. Include the issue number with format Mentioned-Issue: ## in the pull request description. For example:

    Mentioned-Issue: #12345: Fix x bug in y module

  6. And you are done!