From 2e99106a48faf4c3942eb6fa5b230d8521e67143 Mon Sep 17 00:00:00 2001 From: Mohan Raj Date: Sat, 2 Mar 2024 18:02:14 +0000 Subject: [PATCH 1/2] add contributing link --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 623df23..9474db5 100644 --- a/README.md +++ b/README.md @@ -109,3 +109,7 @@ The WordPress unit and integration tests depends on `wp-env` setup. Ensure you r The E2E tests depends on `wp-env` setup. Ensure you run `wp-env start` before running the tests. - Run `yarn test:e2e` to run all Playwright e2e tests. + +## Contributing + +Code contributions, feedback, issue reporting and feature suggestions are welcome. See CONTRIBUTING.md for more details. From f435d36260309142af9ad6361bbfaf62c67261c1 Mon Sep 17 00:00:00 2001 From: Mohan Raj Date: Sat, 2 Mar 2024 18:23:21 +0000 Subject: [PATCH 2/2] add contributing page --- .github/workflows/js.yml | 2 +- .github/workflows/php.yml | 2 +- CODEOWNERS | 1 + CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ README.md | 2 +- 5 files changed, 34 insertions(+), 3 deletions(-) create mode 100644 CODEOWNERS create mode 100644 CONTRIBUTING.md diff --git a/.github/workflows/js.yml b/.github/workflows/js.yml index 6e1d325..037f66c 100644 --- a/.github/workflows/js.yml +++ b/.github/workflows/js.yml @@ -5,7 +5,7 @@ on: - 'main-built' jobs: - lint-test: + js-lint-test: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml index d593720..c567e0c 100644 --- a/.github/workflows/php.yml +++ b/.github/workflows/php.yml @@ -5,7 +5,7 @@ on: - 'main-built' jobs: - lint-test: + php-lint-test: timeout-minutes: 60 runs-on: ubuntu-latest strategy: diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..a2e7863 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @m0hanraj diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6ccf35e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to WP Feature Flags plugin + +Code contributions, feedback, issue reporting and feature suggestions are welcome. Development MUST happen in `feature` branch that's branched off from `main`. All pull requests MUST be made against `main` branch. + +## Setting up Locally + +You can clone this repo and activate it like a normal WordPress plugin, but you'll need to install the developer dependencies in order to build the assets and to run the tests. + +### Prerequisites + +- [Composer](https://getcomposer.org/) +- [Node](https://nodejs.org/) +- [Yarn](https://yarnpkg.com/getting-started/install) +- [Typescript](https://www.typescriptlang.org/) + +### Setup + +1. [PHP and JS install and build](https://github.com/codebtech/wp-feature-flags?tab=readme-ov-file#development-setup) +2. `wp-env` is used for [local development](https://github.com/codebtech/wp-feature-flags?tab=readme-ov-file#development-setup) +3. [Linting and formatting](https://github.com/codebtech/wp-feature-flags?tab=readme-ov-file#development-setup) +4. [Automated testing guidelines](https://github.com/codebtech/wp-feature-flags?tab=readme-ov-file#development-setup) + +### Ahead of raising PR + +1. Make sure you run all linting and tests and everything should pass. +2. Add tests for new changes + +### Release and tagging + +Once the PR is reviewed and approved the maintainers will perform the release process and issue the new release tag. diff --git a/README.md b/README.md index 9474db5..d10bbc3 100644 --- a/README.md +++ b/README.md @@ -112,4 +112,4 @@ The E2E tests depends on `wp-env` setup. Ensure you run `wp-env start` before ru ## Contributing -Code contributions, feedback, issue reporting and feature suggestions are welcome. See CONTRIBUTING.md for more details. +Code contributions, feedback, issue reporting and feature suggestions are welcome. See [CONTRIBUTING.md](https://github.com/codebtech/wp-feature-flags/blob/main/CONTRIBUTING.md) for more details.