Merge pull request #77 from codebtech/chore/contributing

chore: Add contributing.md

Author: m0hanraj

.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

.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:

CODEOWNERS

@@ -0,0 +1 @@
+* @m0hanraj

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.

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](https://github.com/codebtech/wp-feature-flags/blob/main/CONTRIBUTING.md) for more details.