yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2026-01-06 12:13:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Improve wording of contributing guide

Browse Source
This commit is contained in:
Gustav Hansen 2022-03-11 13:55:27 +01:00
parent 6b900e7573
commit f435ad12ca
1 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
CONTRIBUTING.md
View File

@ -2,7 +2,7 @@
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. See the [LICENSE](https://github.com/strapi/strapi/blob/master/LICENSE) licensing information. All work done is available on GitHub.
We highly appreciate your effort to contribute, but we recommend you to talk to a maintainer prior to spending a lot of time making a pull request that may not align with the project roadmap. Every pull request, whether is from strapi or contributors, goes through the same process.
We highly appreciate your effort to contribute, but we recommend you talk to a maintainer before spending a lot of time making a pull request that may not align with the project roadmap. Whether it is from Strapi or contributors, every pull request goes through the same process.
## Feature Requests
@ -10,11 +10,11 @@ Feature Requests by the community are highly encouraged. Feel free to submit a n
## Request For Comments (RFC)
Larger chunks of changes in Strapi, that might effect many users, require a thorough design phase before starting working on a PR.
Larger chunks of changes to Strapi that might affect many users require a thorough design phase before starting working on a PR. We will do our best to respond as soon as possible, but since we need to discuss these proposals thoroughly, please do not expect them to be merged and accepted immediately.
The 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 process will help us create consensus among the core team and include as much feedback as possible from the community for these upcoming changes.
Request For Comments have to be created on the [strapi/rfcs](https://github.com/strapi/rfcs) repository.
A Request For Comments has to be created on the [strapi/rfcs](https://github.com/strapi/rfcs) repository.
## Code of Conduct
@ -24,11 +24,11 @@ This project, and everyone participating in it, are governed by the [Strapi Code
### Individual contribution
In order to accept your pull request, you need to submit a Contributor License Agreement (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 submit a pull request and our CLA bot will automatically ask you to sign before merging the pull request.
You need to sign a Contributor License Agreement (CLA) to accept your pull request. You only need to do this once. If you submit a pull request for the first time, you can complete your CLA [here](https://cla.strapi.io/strapi/strapi), or our CLA bot will automatically ask you to sign before merging the pull request.
### Company contribution
If you are making contributions to our repositories on behalf of your company, then we will need a Corporate Contributor License Agreement (CLA) signed. In order to do that, please contact us at [contributions@strapi.io](mailto:contributions@strapi.io).
If you make contributions to our repositories on behalf of your company, we will need a Corporate Contributor License Agreement (CLA) signed. To do that, please get in touch with us at [contributions@strapi.io](mailto:contributions@strapi.io).
## Documentation
@ -36,13 +36,13 @@ Pull requests related to fixing documentation for the latest release should be d
## Bugs
Strapi is using [GitHub issues](https://github.com/strapi/strapi/issues) to manage bugs. We keep a close eye on them. Before filing a new issue, try to make sure your problem does not already exist.
Strapi is using [GitHub issues](https://github.com/strapi/strapi/issues) to manage bugs. We keep a close eye on them. Before filing a new issue, try to ensure your problem does not already exist.
---
## Before Submitting a Pull Request
The Strapi core team will review your pull request and either merge it, request changes to it, or close it.
The Strapi core team will review your pull request and either merge it, request changes, or close it.
## Contribution Prerequisites
@ -53,7 +53,7 @@ The Strapi core team will review your pull request and either merge it, request
- Fork the repository and create your new branch from `master`.
- 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
- If you've fixed a bug or added code that should be tested, please make sure to add tests
- Ensure the following test suites are passing:
- `yarn test:unit`
- `yarn test:front`
@ -79,6 +79,7 @@ Go to the root of the repository and run the setup:
```bash
cd strapi
yarn setup
```
### 4. Start the example application
@ -129,7 +130,7 @@ $ yarn test:generate-app postgres
$ yarn test:generate-app mysql
```
A new app is required every time you run the end-to-end tests< otherwise, the test suite will fail. A script is available to make this process easier: `node test/e2e.js`. It will delete the current test app, generate a new one and run the test suite.
A new app is required every time you run the end-to-end tests otherwise, the test suite will fail. A script is available to make this process easier: `node test/e2e.js`. It will delete the current test app, generate a new one and run the test suite.
### Changing the database
@ -143,7 +144,7 @@ $ node test/e2e.js --db=mysql
### Running the tests for the Community Editon (CE)\*\*
The test suites are running the tests for the Enterprise Edition (EE) version of Strapi by default. Should you want to test the Community Edition (CE) version, you will need to set the environment variable `STRAPI_DISABLE_EE` to true:
The test suites run the tests for the Enterprise Edition (EE) version of Strapi by default. Should you want to test the Community Edition (CE) version, you will need to set the environment variable `STRAPI_DISABLE_EE` to true:
```bash
$ STRAPI_DISABLE_EE=true node test/e2e.js
@ -152,7 +153,7 @@ $ STRAPI_DISABLE_EE=true yarn test:e2e
### Specifying a license to use for the Enterprise Edition (EE)
The Enterprise Edition tests need a valid license to run correctly. To specify a license you can use the environment variable `STRAPI_LICENSE`:
The Enterprise Edition tests need a valid license to run correctly. To specify a license, you can use the environment variable `STRAPI_LICENSE`:
```bash
$ STRAPI_LICENSE=<license> node test/e2e.js
@ -165,28 +166,28 @@ $ STRAPI_LICENSE=<license> yarn test:e2e
### Repository Organization
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 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/strapi) so that you are 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, the master branch can move 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 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 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://docs.strapi.io).
- Ask a member of the community in the [Strapi Discord Community](https://discord.strapi.io/).
- Ask a question on the [Strapi community forum](https://forum.strapi.io).
- Your issue title is concise, on-topic and polite.
- Your issue title is concise, on-topic, and polite.
- You provide steps to reproduce the issue.
- You have tried all the following (if relevant) and your issue remains:
- You have tried all the following (if relevant), and your issue remains:
- Make sure you have the right application started.
- Make sure the [issue template](.github/ISSUE_TEMPLATE) is respected.
- Make sure your issue body is readable and [well formatted](https://guides.github.com/features/mastering-markdown).
- Make sure you've stopped the Strapi server with CTRL+C and restarted it.
- Make sure your application has a clean `node_modules` directory, meaning:
- you didn't linkt any dependencies (e.g. by running `yarn link`)
- you didn't link any dependencies (e.g., by running `yarn link`)
- you haven't made any inline changes to files in the `node_modules` directory
- you don't have any global dependency loops. The easiest way to double-check any of the above, if you aren't sure, is to run: `$ rm -rf node_modules && yarn cache clean && yarn setup`.
- you don't have any global dependency loops. If you aren't sure, the easiest way to double-check any of the above is to run: `$ rm -rf node_modules && yarn cache clean && yarn setup`.