Skip to content

Commit

Permalink
minor #767 Improved the CONTRIBUTING guide with more Git information …
Browse files Browse the repository at this point in the history
…(javiereguiluz)

This PR was squashed before being merged into the master branch (closes #767).

Discussion
----------

Improved the CONTRIBUTING guide with more Git information

Commits
-------

e5107a9 Improved the CONTRIBUTING guide with more Git information
  • Loading branch information
javiereguiluz committed Jan 5, 2016
2 parents e007b76 + e5107a9 commit 758221f
Showing 1 changed file with 34 additions and 11 deletions.
45 changes: 34 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ the bundle. This means that we routinely reject any feature that complicates the
code too much or which doesn't fit in the bundle's philosophy.

That's why **we strongly recommend you** to propose new features by
[opening a new issue][create-issue] in the repository instead of submitting a
pull request with the code of the proposed feature.
[opening a new issue][create-issue] in the repository to discuss about them
instead of submitting a pull request with the code of the proposed feature.

Reporting Bugs
--------------
Expand All @@ -51,19 +51,42 @@ Sending Pull Requests
### Making your changes

1. Fork [the EasyAdmin repository][easyadmin-repository] on GitHub and clone it
in your computer.
in your computer:

```bash
$ git clone git://github.com/<YOUR GITHUB USERNAME>/EasyAdminBundle.git
```

2. Create a new branch for the new code (if you are fixing a bug, you can call
this branch `fix_NNN`, where `NNN` is the number of the related issue).
this branch `fix_NNN`, where `NNN` is the number of the related issue):

```bash
$ git checkout -b fix_NNN
```

3. Make your code changes (use the same code syntax as Symfony described in
[PSR-2][psr2-standard]).
4. Make sure that your code is **compatible with PHP 5.3 and Symfony 2.3**.
Sometimes it's tricky to develop code compatible with Symfony 2.3 and 3.x.
If you get stuck, just ask us and we'll help you.
[PSR-2][psr2-standard]) and submit the changes. Make sure that your code is
**compatible with PHP 5.3 and Symfony 2.3**. Sometimes it's tricky to develop
code compatible with Symfony 2.3 and 3.x. If you get stuck, just ask us and
we'll help you.

### Submitting your changes

1. Commit and push your changes to your own fork (`git commit -a` and `git push`).
2. [Create a new pull request][create-pr] in the EasyAdmin GitHub repository.
1. Commit and push your changes to your own fork:

```bash
# optional: needed only if you have added new files
$ git add --all

$ git commit path/to/modified/files
# alternative: "git commit -a" to commit all the modified files

# if this doesn't work, try: "git push origin <branch_name>"
$ git push
```

2. Go to the GitHub website and [create a new pull request][create-pr] in the
EasyAdmin repository.
3. Provide a short description about the changes made by the pull request.
If you are fixing a bug, add the text `Fixed #NNN` and provide the number of
the related issue (this allows us to track which bugs have already been fixed).
Expand All @@ -72,7 +95,7 @@ Sending Pull Requests
In case some changes are merged in the repository since you submitted your pull
request, we may ask you to rebase it to make it mergeable again:

``` bash
```bash
$ git remote add upstream git@github.com:javiereguiluz/EasyAdminBundle.git
$ git pull --rebase upstream master
$ git push -f origin the_name_of_your_branch
Expand Down

0 comments on commit 758221f

Please sign in to comment.