X-Git-Url: https://git.reactos.org/?p=reactos.git;a=blobdiff_plain;f=CONTRIBUTING.md;h=fc1f21b1883c556e3f14f730e4cbbf6679bdf596;hp=028fe8bead06b11952817c861c9ec426988b69ba;hb=2949b2f08b57d0ae6105fdeae72f865152d91f5f;hpb=a4f0a2390b9af18e2878671a2e26a89d979e788e diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 028fe8bead0..fc1f21b1883 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,7 +49,7 @@ Your contribution can be of numerous forms. We currently accept two ways to cont ### Pull Requests -Since our [migration to GitHub] we gladly accept __[Pull Requests]__. Pull requests let you tell others about changes you have pushed to a repository on GitHub. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before the changes are merged into the repository. __Pull request is a prefered way to submit your work__ - it makes reviewing and merging your contribution much easier. +Since our [migration to GitHub] we gladly accept __[Pull Requests]__. Pull requests let you tell others about changes you have pushed to a repository on GitHub. Once a pull request is opened, you can discuss and review the potential changes with collaborators and add follow-up commits before the changes are merged into the repository. __Pull request is a preferred way to submit your work__ - it makes reviewing and merging your contribution much easier. ### Patches @@ -57,6 +57,10 @@ A __[patch]__ is a set of changes to existing source code. The changes in a patc See [Submitting Patches] for details. +### Commit style + +Our commit style is defined in a __[commit template]__. Use it as a reference or turn it on using `git config commit.template .gitmessage`. This will set this template as an initial commit message for the new commits in your local repository. + ### Rules and Recommendations - *Use your __real name__ and __real email__.* We do not accept anonymous contributions! @@ -67,6 +71,8 @@ See [Submitting Patches] for details. - *Respect our __[Coding Style]__ and __[Programming Guidelines]__.* - *Do not be afraid to ask questions.* Ask our developers on JIRA or [IRC] channel. +To amend your commit with your name and e-mail (in any case you've forgot to set your name/e-mail) please take a look at this [guide](https://reactos.org/wiki/ReactOS_Git_For_Dummies#Amending_your_commit_with_name.2FE-mail). To set your name/e-mail globally for future commits that you push, [read this](https://reactos.org/wiki/ReactOS_Git_For_Dummies#Assign_commits_with_your_name_.26_E-mail_automatically). + ## Where To Start? Finding a good project to start with can be a challenge, because when starting out you are (usually) not aware of all the possibilities. To help you find a project, here are some ideas to try: @@ -96,3 +102,8 @@ Finding a good project to start with can be a challenge, because when starting o [README.FSD]: /media/doc/README.FSD [Coverity]: https://scan.coverity.com/projects/reactos [request-coverity]: https://scan.coverity.com/memberships/new?project_id=reactos + [commit template]: .gitmessage + +# See Also + +- [Rules for managing Pull Requests](PULL_REQUEST_MANAGEMENT.md)