Skip to content

Instantly share code, notes, and snippets.

@MarcDiethelm
Last active August 21, 2025 06:42
Show Gist options
  • Save MarcDiethelm/7303312 to your computer and use it in GitHub Desktop.
Save MarcDiethelm/7303312 to your computer and use it in GitHub Desktop.

Revisions

  1. Marc Diethelm revised this gist Mar 19, 2014. 1 changed file with 6 additions and 0 deletions.
    6 changes: 6 additions & 0 deletions Contributing.md
    Original file line number Diff line number Diff line change
    @@ -1,3 +1,9 @@

    This text now lives at https://github.com/MarcDiethelm/contributing/blob/master/README.md.
    I turned it into a Github repo so you can, you know, contribute to it by making pull requests.

    ---

    ## Contributing

    If you want to contribute to a project and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.
  2. Marc Diethelm revised this gist Mar 19, 2014. 1 changed file with 4 additions and 2 deletions.
    6 changes: 4 additions & 2 deletions Contributing.md
    Original file line number Diff line number Diff line change
    @@ -10,7 +10,7 @@ Look for a project's contribution instructions. If there are any, follow them.
    - Clone the fork on your local machine. Your remote repo on Github is called `origin`.
    - Add the original repository as a remote called `upstream`.
    - If you created your fork a while ago be sure to pull upstream changes into your local repository.
    - Create a new branch to work on! Branch `develop` if it exists, else from `master`.
    - Create a new branch to work on! Branch from `develop` if it exists, else from `master`.
    - Implement/fix your feature, comment your code.
    - Follow the code style of the project, including indentation.
    - If the project has tests run them!
    @@ -21,4 +21,6 @@ Look for a project's contribution instructions. If there are any, follow them.
    - From your fork open a pull request in the correct branch. Target the project's `develop` branch if there is one, else go for `master`!
    - ...
    - Once the pull request is approved and merged you can pull the changes from `upstream` to your local repo and delete
    your extra branch(es).
    your extra branch(es).

    And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.
  3. MarcDiethelm revised this gist Jan 19, 2014. 1 changed file with 1 addition and 0 deletions.
    1 change: 1 addition & 0 deletions Contributing.md
    Original file line number Diff line number Diff line change
    @@ -13,6 +13,7 @@ Look for a project's contribution instructions. If there are any, follow them.
    - Create a new branch to work on! Branch `develop` if it exists, else from `master`.
    - Implement/fix your feature, comment your code.
    - Follow the code style of the project, including indentation.
    - If the project has tests run them!
    - Write or adapt tests as needed.
    - Add or change the documentation as needed.
    - Squash your commits into a single commit with git's [interactive rebase](https://help.github.com/articles/interactive-rebase). Create a new branch if necessary.
  4. MarcDiethelm revised this gist Jan 16, 2014. 1 changed file with 2 additions and 1 deletion.
    3 changes: 2 additions & 1 deletion Contributing.md
    Original file line number Diff line number Diff line change
    @@ -9,7 +9,8 @@ Look for a project's contribution instructions. If there are any, follow them.
    - Create a personal fork of the project on Github.
    - Clone the fork on your local machine. Your remote repo on Github is called `origin`.
    - Add the original repository as a remote called `upstream`.
    - Create a new branch to work on!
    - If you created your fork a while ago be sure to pull upstream changes into your local repository.
    - Create a new branch to work on! Branch `develop` if it exists, else from `master`.
    - Implement/fix your feature, comment your code.
    - Follow the code style of the project, including indentation.
    - Write or adapt tests as needed.
  5. MarcDiethelm revised this gist Nov 22, 2013. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion Contributing.md
    Original file line number Diff line number Diff line change
    @@ -2,7 +2,7 @@

    If you want to contribute to a project and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.

    How to make a clean pull request
    ### How to make a clean pull request

    Look for a project's contribution instructions. If there are any, follow them.

  6. MarcDiethelm revised this gist Nov 4, 2013. 1 changed file with 2 additions and 2 deletions.
    4 changes: 2 additions & 2 deletions Contributing.md
    Original file line number Diff line number Diff line change
    @@ -11,8 +11,8 @@ Look for a project's contribution instructions. If there are any, follow them.
    - Add the original repository as a remote called `upstream`.
    - Create a new branch to work on!
    - Implement/fix your feature, comment your code.
    - Follow the code style of the framework, including indentation.
    - Write or adapt framework tests as needed.
    - Follow the code style of the project, including indentation.
    - Write or adapt tests as needed.
    - Add or change the documentation as needed.
    - Squash your commits into a single commit with git's [interactive rebase](https://help.github.com/articles/interactive-rebase). Create a new branch if necessary.
    - Push your branch to your fork on Github, the remote `origin`.
  7. MarcDiethelm revised this gist Nov 4, 2013. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion Contributing.md
    Original file line number Diff line number Diff line change
    @@ -4,7 +4,7 @@ If you want to contribute to a project and make it better, your help is very wel

    How to make a clean pull request

    - Look for a project's contribution instructions. If there are any, follow them.
    Look for a project's contribution instructions. If there are any, follow them.

    - Create a personal fork of the project on Github.
    - Clone the fork on your local machine. Your remote repo on Github is called `origin`.
  8. MarcDiethelm created this gist Nov 4, 2013.
    22 changes: 22 additions & 0 deletions Contributing.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,22 @@
    ## Contributing

    If you want to contribute to a project and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.

    How to make a clean pull request

    - Look for a project's contribution instructions. If there are any, follow them.

    - Create a personal fork of the project on Github.
    - Clone the fork on your local machine. Your remote repo on Github is called `origin`.
    - Add the original repository as a remote called `upstream`.
    - Create a new branch to work on!
    - Implement/fix your feature, comment your code.
    - Follow the code style of the framework, including indentation.
    - Write or adapt framework tests as needed.
    - Add or change the documentation as needed.
    - Squash your commits into a single commit with git's [interactive rebase](https://help.github.com/articles/interactive-rebase). Create a new branch if necessary.
    - Push your branch to your fork on Github, the remote `origin`.
    - From your fork open a pull request in the correct branch. Target the project's `develop` branch if there is one, else go for `master`!
    - ...
    - Once the pull request is approved and merged you can pull the changes from `upstream` to your local repo and delete
    your extra branch(es).