yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-09-10 17:17:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Update contributing guide

Browse Source
This commit is contained in:
Gustav Hansen 2022-01-31 09:36:03 +01:00
parent 0dd74c685b
commit b8753c9d35
1 changed files with 44 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
CONTRIBUTING.md
View File

@ -1,6 +1,6 @@
# Contribute to Strapi
Strapi is an open-source project administered by [the Strapi team](https://strapi.io/company). We appreciate your interest and efforts to contribute to Strapi.
Strapi is an open-source project administered by [the Strapi team](https://strapi.io/about-us). We appreciate your interest and efforts to contribute to Strapi.
All efforts to contribute are highly appreciated, we recommend you talk to a maintainer prior to spending a lot of time making a pull request that may not align with the project roadmap.
@ -14,23 +14,23 @@ The core team and the contributors send pull requests which go through the same
Feature Requests by the community are highly encouraged. Please feel free to submit a [feature request](https://portal.productboard.com/strapi) or to upvote 👍 [an existing feature request](https://portal.productboard.com/strapi) in the ProductBoard.
## RFCs
## Request For Comments (RFCs)
Some important changes in Strapi require some thoughts to be put into the design phase before starting working on a PR.
Larger changes in Strapi require a thourough design phase before starting working on a PR.
The RFC (Request For Comments) process will help us create consensus among the core team and include as much feedback as possible from the community, for these upcoming changes.
The Request For Comments (RFC) process will help us create consensus among the core team and include as much feedback as possible from the community, for these upcoming changes.
Before contributing, you will probably have to create a RFC on this [strapi/rfcs](https://github.com/strapi/rfcs) repo.
Before contributing larger chunks of code that might affect core functionalities, you will have to create a public RFC on the [strapi/rfcs](https://github.com/strapi/rfcs) repository.
## Code of Conduct
This project and everyone participating in it are governed by the [Strapi Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please read the [full text](CODE_OF_CONDUCT.md) so that you can read which actions may or may not be tolerated.
This project and everyone participating in it, are governed by the [Strapi Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold it. Make sure to read the [full text](CODE_OF_CONDUCT.md), to understand which type of actions may or may not be tolerated.
## Contributor License Agreement (CLA)
### Individual
In order to accept your pull request, we need you to submit a CLA. You only need to do this once. If you are submitting a pull request for the first time, you can complete your CLA [here](https://cla.strapi.io/strapi/strapi) or just submit a Pull Request and our CLA Bot will ask you to sign the CLA before merging your Pull Request.
In order to accept your pull request, we need you to submit a CLA. You only need to do this once. If you are submitting a pull request for the first time, you can complete your CLA [here](https://cla.strapi.io/strapi/strapi) or just submit a pull request and our CLA Bot will ask you to sign the CLA before merging it.
### Company
@ -38,11 +38,11 @@ If you are making contributions to our repositories on behalf of your company, t
## Documentation
Pull requests relating to fixing documentation for the latest release should be directed towards the [documentation repo](https://github.com/strapi/documentation). Please see the documentation [contributing guide](https://github.com/strapi/documentation/blob/main/CONTRIBUTING.md) for more information on how to make the documentation pull request.
Pull requests relating to fixing documentation for the latest release should be directed towards the [documentation repo](https://github.com/strapi/documentation). Please see the documentation [contributing guide](https://github.com/strapi/documentation/blob/main/CONTRIBUTING.md) for more information.
## Bugs
We are using [GitHub Issues](https://github.com/strapi/strapi/issues) to manage our public bugs. We keep a close eye on this so before filing a new issue, try to make sure the problem does not already exist.
We are using [GitHub Issues](https://github.com/strapi/strapi/issues) to manage our public bugs. We keep a close eye on them. Before filing a new issue, try to make sure your problem does not already exist.
---
@ -53,31 +53,30 @@ The core team will review your pull request and will either merge it, request ch
**Before submitting your pull request** make sure the following requirements are fulfilled:
- Fork the repository and create your branch from `master`.
- Run `yarn setup` in the repository root.
- If you’ve fixed a bug or added code that should be tested, add the tests and then link the corresponding issue in either your commit or your PR!
- Run `yarn setup` in the root of the repository.
- If you’ve fixed a bug or added code that should be tested, please make sure to add tests
- Ensure the test suites are passing:
- `yarn test:unit`
- `yarn test:front`
- Make sure your code lints (`yarn lint`).
- If your contribution fixes an existing issue, please make sure to link it in your pull request.
## Contribution Prerequisites
- You have [Node](https://nodejs.org/en/) at >= v12 and <= v16 and [Yarn](https://yarnpkg.com/en/) at v1.2.0+.
- You are familiar with Git.
- You have [Node.js](https://nodejs.org/en/) at version >= v12 and <= v16 and [Yarn](https://yarnpkg.com/en/) at v1.2.0+ installed.
- You are familiar with [Git](https://git-scm.com).
## Development Workflow
_For users running on Apple Silicon M1, you may encounter errors thrown by `sharp`. You may need to re-install `libvps` or to build `sharp` manually following [this issue comment](https://github.com/lovell/sharp/issues/2460#issuecomment-751491241) in order to start the project._
To facilitate the contribution, we have drastically reduced the amount of commands necessary to install the entire development environment.
First of all, you need to check if you are using the [required versions of Node.js and npm](https://docs.strapi.io/developer-docs/latest/setup-deployment-guides/deployment.html).
First of all, you need to check if you're using the [required versions of Node.js and npm](https://docs.strapi.io/developer-docs/latest/setup-deployment-guides/deployment.html).
Then, please follow the instructions below:
Now, please follow the instructions below:
#### 1. Fork the [repository](https://github.com/strapi/strapi)
[Go to the repository](https://github.com/strapi/strapi) and fork it to your own GitHub account.
[Go to the repository](https://github.com/strapi/strapi) and fork it using your own GitHub account.
#### 2. Clone from your repository
@ -87,32 +86,32 @@ git clone git@github.com:YOUR_USERNAME/strapi.git
#### 3. Install the dependencies
Go to the root of the repository.
Go to the root of the repository and run the common setup:
```bash
cd strapi && yarn setup
cd strapi
yarn setup
```
#### 4. Start the example application
To start a test example application to test your changes quickly and also for the next step.
```bash
cd strapi/examples/getstarted && yarn develop
```
Read the `getstarted` application README [here](./examples/getstarted/README.md) for more details.
#### 5. Running the administration panel in development mode
**Start the administration panel server for development**
```bash
cd strapi/packages/strapi-admin
cd ./examples/getstarted
yarn develop
```
The administration panel will be available at http://localhost:4000/admin
Make sure to read the [`getstarted` application README](./examples/getstarted/README.md) for more details.
#### 5. Running the administration panel in development mode
Start the administration panel server for development:
```bash
cd ./packages/core/admin
yarn develop
```
The administration panel should now be available at http://localhost:4000/admin
**Awesome! You are now able to contribute to Strapi.**
@ -120,10 +119,10 @@ The administration panel will be available at http://localhost:4000/admin
- `yarn watch` starts yarn watch in all packages.
- `yarn build` builds the `strapi-helper-plugin` (use this command when you develop in the administration panel).
- `yarn setup` installs the dependencies.
- `yarn setup` installs dependencies.
- `yarn lint` lints the codebase.
- `yarn test:clean` removes the coverage.
- `yarn test:front` runs the front-end related tests.
- `yarn test:clean` removes the coverage reports.
- `yarn test:front` runs front-end related tests.
- `yarn test:front:watch` runs an interactive test watcher for the front-end.
- `yarn test:unit` runs the back-end unit tests.
- `yarn test:e2e` runs an end-to-end test suite.
@ -138,7 +137,6 @@ The end-to-end tests require a Strapi app to be able to run. You can generate a
```bash
$ yarn test:generate-app sqlite
$ yarn test:generate-app mongo
$ yarn test:generate-app postgres
$ yarn test:generate-app mysql
```
@ -155,18 +153,18 @@ $ node test/e2e.js --db=postgres
$ node test/e2e.js --db=mysql
```
**Running the tests for the CE**
**Running the tests for the Community Editon (CE)**
The test suites will run the tests for the EE version of Strapi. Should you want to test the CE version you will need to use the ENV variable `STRAPI_DISABLE_EE`:
The test suites will run the tests for the Enterprise Edition (EE) version of Strapi. Should you want to test the Community Edition (CE) version you will need to set the environment variable `STRAPI_DISABLE_EE`:
```bash
$ STRAPI_DISABLE_EE=true node test/e2e.js
$ STRAPI_DISABLE_EE=true yarn test:e2e
```
**Specifying a license to use for the EE e2e tests**
**Specifying a license to use for the Enterprise Edition (EE) e2e tests**
The EE tests need a valid license to run correctly. To specify which license to use you can use `STRAPI_LICENSE`. You can specify it in an env file or as a prefix to the cli command:
The Enterprise Edition tests need a valid license to run correctly. To specify which license to use you can use the environment variable `STRAPI_LICENSE`. You can specify it either in an environment file or before running the CLI command:
```bash
$ STRAPI_LICENSE=<license> node test/e2e.js
@ -179,18 +177,18 @@ $ STRAPI_LICENSE=<license> yarn test:e2e
### Repository Organization
We chose to use a monorepo design that exploits [Yarn Workspaces](https://yarnpkg.com/en/docs/workspaces) in the way [React](https://github.com/facebook/react/tree/master/packages) or [Babel](https://github.com/babel/babel/tree/master/packages) does. This allows the community to easily maintain the whole ecosystem, keep it up-to-date and consistent.
We chose to use a monorepo design using [Yarn Workspaces](https://yarnpkg.com/en/docs/workspaces) in the way [React](https://github.com/facebook/react/tree/master/packages) or [Babel](https://github.com/babel/babel/tree/master/packages) does. This allows us to maintain the whole ecosystem, keep it up-to-date and consistent.
We do our best to keep the master branch as clean as possible, with tests passing at all times. However, it may happen that the master branch moves faster than the release cycle. Therefore check the [releases on npm](https://www.npmjs.com/package/strapi) so that you're always up-to-date with the latest stable version.
We do our best to keep the master branch as clean as possible, with tests passing at all times. However, it may happen that the master branch moves faster than the release cycle. Therefore check the [releases on npm](https://www.npmjs.com/package/@strapi/strapi) so that you are always up-to-date with the latest stable version.
### Reporting an issue
Before submitting an issue you need to make sure:
- You are experiencing a concrete technical issue with Strapi.
- You are experiencing a technical issue with Strapi.
- You have already searched for related [issues](https://github.com/strapi/strapi/issues), and found none open (if you found a related _closed_ issue, please link to it from your post).
- You are not asking a question about how to use Strapi or about whether or not Strapi has a certain feature. For general help using Strapi, you may:
- Refer to [the official Strapi documentation](https://strapi.io).
- Refer to [the official Strapi documentation](https://docs.strapi.io).
- Ask a member of the community in the [Strapi Discord Community](https://discord.strapi.io/).
- Ask a question on [our community forum](https://forum.strapi.io).
- Your issue title is concise, on-topic and polite.