From 77a5cf5a4b33405c1e7e065de6bed07b08568918 Mon Sep 17 00:00:00 2001 From: Abdul Malik Ikhsan Date: Thu, 20 May 2021 06:11:10 +0700 Subject: [PATCH] [Doc] Add CONTRIBUTING.md --- .github/workflows/build_scoped_rector.yaml | 1 + .../workflows/build_scoped_rector_php70.yaml | 1 + CONTRIBUTING.md | 21 +++++++++++++++++++ README.md | 18 +--------------- 4 files changed, 24 insertions(+), 17 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/.github/workflows/build_scoped_rector.yaml b/.github/workflows/build_scoped_rector.yaml index f201fc514f6..a0c0b0eb18c 100644 --- a/.github/workflows/build_scoped_rector.yaml +++ b/.github/workflows/build_scoped_rector.yaml @@ -58,6 +58,7 @@ jobs: - run: | cp -R build/target-repository/. rector-prefixed-downgraded cp -R templates rector-prefixed-downgraded/ + cp CONTRIBUTING.md rector-prefixed-downgraded/ # 6. clone remote repository, so we can push it - diff --git a/.github/workflows/build_scoped_rector_php70.yaml b/.github/workflows/build_scoped_rector_php70.yaml index 921b64e331a..5d0b12c60c0 100644 --- a/.github/workflows/build_scoped_rector_php70.yaml +++ b/.github/workflows/build_scoped_rector_php70.yaml @@ -82,6 +82,7 @@ jobs: - run: | cp -R build/target-repository-php70/. rector-prefixed-downgraded-php70 cp -R templates rector-prefixed-downgraded-php70/ + cp CONTRIBUTING.md rector-prefixed-downgraded-php70/ # 6. clone remote repository, so we can push it - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..596ea9dc89f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +## How to Contribute + +Contributions here are more than welcomed! You can contribute to [rector-src](https://github.com/rectorphp/rector-src) repository. + +There 3 rules will highly increase changes to get your PR merged: + +- **1 feature per pull-request** +- **new features need tests** +- CI must pass... you can mimic it locally by running + + ```bash + composer complete-check + ``` + +- Do you need to fix coding standards? + + ```bash + composer fix-cs + ``` + +We would be happy to accept PRs that follow these guidelines. \ No newline at end of file diff --git a/README.md b/README.md index 59869981926..30485c1066c 100644 --- a/README.md +++ b/README.md @@ -15,23 +15,7 @@ Code of this repository requires PHP 8. For `rector/rector` package user the bui ## How to Contribute -Contributions here are more than welcomed! There 3 rules will highly increase changes to get your PR merged: - -- **1 feature per pull-request** -- **new features need tests** -- CI must pass... you can mimic it locally by running - - ```bash - composer complete-check - ``` - -- Do you need to fix coding standards? - - ```bash - composer fix-cs - ``` - -We would be happy to accept PRs that follow these guidelines. +Please read [contributing guideline](/CONTRIBUTING.md) for how to contribute to rector. ## Code of Conduct