Skip to content

chore: Add contributing.md #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
m0hanraj merged 2 commits into from
Mar 2, 2024
Merged

chore: Add contributing.md #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e99106
add contributing link
mohanrajpac Mar 2, 2024
f435d36
add contributing page
mohanrajpac Mar 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/js.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
- 'main-built'

jobs:
lint-test:
js-lint-test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/php.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
- 'main-built'

jobs:
lint-test:
php-lint-test:
timeout-minutes: 60
runs-on: ubuntu-latest
strategy:
Expand Down
1 change: 1 addition & 0 deletions CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @m0hanraj
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.