X-Git-Url: https://git.reactos.org/?p=reactos.git;a=blobdiff_plain;f=CONTRIBUTING.md;h=fc1f21b1883c556e3f14f730e4cbbf6679bdf596;hp=17465a2063c51b98a9e3434003280cddc1316268;hb=81e27f0be79fb92127d028ecaa876a2a187bbf87;hpb=d7c8a574581c8005303a523fe08c5f0cc853dbe4 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 17465a2063c..fc1f21b1883 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,11 @@ There are several ways to contribute to the development of ReactOS. The most oft - [How To Contribute?](#how-to-contribute?) - [Where To Start?](#where-to-start?) +**Legal notice:** If you have seen Microsoft Windows source code, your contribution won't be accepted because of potential copyright violation. Before contributing, you must affirm that the following is true: +>I hereby swear that I have not used nor seen the source code to any version of the Windows operating system +>nor any Microsoft product that may be related to the proposed project that is under a license incompatible +>with contribution to ReactOS, including but not limited to the leaked Windows 2000 source code and the Windows Research Kernel. + ## What To Do? ### Fix bugs @@ -44,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 @@ -52,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! @@ -62,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: @@ -91,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)