91 lines
3.2 KiB
Markdown
91 lines
3.2 KiB
Markdown
# Contributing
|
|
|
|
We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.
|
|
|
|
## Development Workflow
|
|
|
|
This plugin provides a local development instance of Strapi to develop it's features. We call this instance `playground` and it can be found in the playground folder in the root of the project. For that reason it is not needed to have your own Strapi instance running to work on this plugin. Just clone the repo and you're ready to go!
|
|
|
|
#### 1. Fork the [repository](https://github.com/pluginpal/strapi-plugin-config-sync)
|
|
|
|
[Go to the repository](https://github.com/pluginpal/strapi-plugin-config-sync) and fork it to your own GitHub account.
|
|
|
|
#### 2. Clone the forked repository
|
|
|
|
```bash
|
|
git clone git@github.com:YOUR_USERNAME/strapi-plugin-config-sync.git
|
|
```
|
|
|
|
#### 3. Install the dependencies
|
|
|
|
Go to the folder and install the dependencies
|
|
|
|
```bash
|
|
cd strapi-plugin-config-sync && yarn install
|
|
```
|
|
|
|
#### 4. Install the playground dependencies
|
|
|
|
Run this in the root of the repository
|
|
|
|
```bash
|
|
yarn playground:install
|
|
```
|
|
|
|
#### 5. Run the compiler of the plugin
|
|
|
|
We use `yalc` to publish the package to a local registry. Run the following command o watch for changes and push to `yalc` every time a change is made:
|
|
|
|
```bash
|
|
yarn develop
|
|
```
|
|
|
|
#### 6. Start the playground instance
|
|
|
|
Leave the watcher running, open up a new terminal window and browse back to the root of the plugin repo. Run the following command:
|
|
|
|
```bash
|
|
yarn playground:develop
|
|
```
|
|
|
|
This will start the playground instance that will have the plugin installed from the `yalc` registry. Browse to http://localhost:1337 and create a test admin user to log in to the playground.
|
|
|
|
#### 7. Start your contribution!
|
|
|
|
You can now start working on your contribution. If you had trouble setting up this testing environment please feel free to report an issue on Github.
|
|
|
|
### Commit message convention
|
|
|
|
We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
|
|
|
|
- `fix`: bug fixes, e.g. fix crash due to deprecated method.
|
|
- `feat`: new features, e.g. add new method to the module.
|
|
- `refactor`: code refactor, e.g. migrate from class components to hooks.
|
|
- `docs`: changes into documentation, e.g. add usage example for the module..
|
|
- `test`: adding or updating tests, eg add integration tests using detox.
|
|
- `chore`: tooling changes, e.g. change CI config.
|
|
|
|
### Linting and tests
|
|
|
|
[ESLint](https://eslint.org/)
|
|
|
|
We use [ESLint](https://eslint.org/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.
|
|
|
|
### Scripts
|
|
|
|
The `package.json` file contains various scripts for common tasks:
|
|
|
|
- `yarn eslint`: lint files with ESLint.
|
|
- `yarn eslint:fix`: auto-fix ESLint issues.
|
|
- `yarn test:integration`: run integration tests with Jest.
|
|
|
|
### Sending a pull request
|
|
|
|
When you're sending a pull request:
|
|
|
|
- Prefer small pull requests focused on one change.
|
|
- Verify that linters and tests are passing.
|
|
- Review the documentation to make sure it looks good.
|
|
- Follow the pull request template when opening a pull request.
|
|
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
|