From bd9b59f4019f229dfd350ad85ddb88346a33804f Mon Sep 17 00:00:00 2001 From: "Dylan K. Taylor" Date: Mon, 21 May 2018 09:59:44 +0100 Subject: [PATCH] Contributing: be more clear about committing on GitHub --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 84cac4b604..e773e45c7e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,7 +42,7 @@ We try to ensure that our project's codebase is as clean as possible and ensure - **Details should be provided of tests done.** Simply saying "Tested" or equivalent is not acceptable. ### Code contributions -- **Avoid using GitHub Web Editor**. The web editor lacks most useful GIT features and **should only be used for very minor changes**. It is immediately clear if the web editor has been used, and if so the PR is more likely to be rejected. If you want to make serious contributions, **please learn how to use [GIT version control](https://git-scm.com/)**. +- **Avoid committing changes directly on GitHub. This includes use of the web editor, and also uploading files.** The web editor lacks most useful GIT features and **should only be used for very minor changes**. It is immediately clear if the web editor has been used, and if so the PR is more likely to be rejected. If you want to make serious contributions, **please learn how to use [GIT version control](https://git-scm.com/)**. - **Do not copy-paste code**. There are potential license issues implicit with copy-pasting, and copy-paste usually indicates a lack of understanding of the actual code. Copy-pasted code is obvious a mile off and **any PR like this is likely to be closed**. If you want to use somebody else's code from a Git repository, **use [GIT's cherry-pick feature](https://git-scm.com/docs/git-cherry-pick)** to cherry-pick the commit. **Cherry-picking is the politer way to copy somebody's changes** and retains all the original accreditation, so there is no need for copy-pasted commits with descriptions like `Some code, thanks @exampleperson`. - **Make sure you can explain your changes**. If you can't provide a good explanation of changes, your PR may be rejected. - **Code should use the same style as in PocketMine-MP.** See [below](#code-syntax) for an example.