From b8753c9d358d271b94e3d04cead4f3c7f15c9f73 Mon Sep 17 00:00:00 2001 From: Gustav Hansen Date: Mon, 31 Jan 2022 09:36:03 +0100 Subject: [PATCH 1/8] Docs: Update contributing guide --- CONTRIBUTING.md | 90 ++++++++++++++++++++++++------------------------- 1 file changed, 44 insertions(+), 46 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c3093a7757..3540a301f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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= node test/e2e.js @@ -179,18 +177,18 @@ $ STRAPI_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. From 253849654281b5bdec96887f81b25c879788d291 Mon Sep 17 00:00:00 2001 From: Gustav Hansen Date: Fri, 4 Feb 2022 10:53:23 +0100 Subject: [PATCH 2/8] Update CONTRIBUTING.md Co-authored-by: Pierre Wizla --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3540a301f4..c9a03927bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ Feature Requests by the community are highly encouraged. Please feel free to sub ## Request For Comments (RFCs) -Larger changes in Strapi require a thourough design phase before starting working on a PR. +Larger changes in Strapi require a thorough design phase before starting working on a PR. 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. From 96a6dec1fe795ee76379525a9027c8d68f0df5e7 Mon Sep 17 00:00:00 2001 From: Gustav Hansen Date: Fri, 4 Feb 2022 10:53:38 +0100 Subject: [PATCH 3/8] Update CONTRIBUTING.md Co-authored-by: Pierre Wizla --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9a03927bd..d40fe52553 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ This project and everyone participating in it, are governed by the [Strapi Code ### 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 it. +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 From 336330abd6ff6e57242ee36ae879852fb3de1014 Mon Sep 17 00:00:00 2001 From: Gustav Hansen Date: Fri, 4 Feb 2022 10:53:45 +0100 Subject: [PATCH 4/8] Update CONTRIBUTING.md Co-authored-by: Pierre Wizla --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d40fe52553..f674a76691 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ Before contributing larger chunks of code that might affect core functionalities ## 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 it. Make sure to read the [full text](CODE_OF_CONDUCT.md), to understand which type of 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) From e9790c758ad5d982a7fb7273685754ad69feaf03 Mon Sep 17 00:00:00 2001 From: Gustav Hansen Date: Fri, 4 Feb 2022 11:00:22 +0100 Subject: [PATCH 5/8] Docs: Make introduction more concise --- CONTRIBUTING.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3540a301f4..00c12833f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,18 +1,12 @@ # 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. +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. -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. - -## Open Development & Community Driven - -Strapi is an open-source project. See the [LICENSE](https://github.com/strapi/strapi/blob/master/LICENSE) file for licensing information. All the work done is available on GitHub. - -The core team and the contributors send pull requests which go through the same validation process. +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. ## Feature Requests -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. +Feature Requests by the community are highly encouraged. Feel free to submit a new one or upvote an existing feature request on [ProductBoard](https://portal.productboard.com/strapi). ## Request For Comments (RFCs) From 03f34f4a8f14f2a7e2e1524a99c9b87bb7cf8459 Mon Sep 17 00:00:00 2001 From: Gustav Hansen Date: Fri, 4 Feb 2022 11:19:40 +0100 Subject: [PATCH 6/8] Docs: Improve wording --- CONTRIBUTING.md | 94 +++++++++++++++++++++++-------------------------- 1 file changed, 44 insertions(+), 50 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a2b8a1224..99322608d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,13 +8,13 @@ We highly appreciate your effort to contribute, but we recommend you to talk to Feature Requests by the community are highly encouraged. Feel free to submit a new one or upvote an existing feature request on [ProductBoard](https://portal.productboard.com/strapi). -## Request For Comments (RFCs) +## Request For Comments (RFC) -Larger changes in Strapi require a thorough design phase before starting working on a PR. +Larger chunks of changes in Strapi, that might effect many users, require a thorough design phase before starting working on a PR. -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. +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. -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. +Request For Comments have to be created on the [strapi/rfcs](https://github.com/strapi/rfcs) repository. ## Code of Conduct @@ -22,72 +22,66 @@ This project, and everyone participating in it, are governed by the [Strapi Code ## Contributor License Agreement (CLA) -### Individual +### Individual contribution -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. +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. -### Company +### 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). ## 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. +Pull requests related to fixing documentation for the latest release should be directed towards the [documentation repository](https://github.com/strapi/documentation). Please follow 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 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 make sure your problem does not already exist. --- ## Before Submitting a Pull Request -The core team will review your pull request and will either merge it, request changes to it, or close it. - -**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 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. +The Strapi core team will review your pull request and either merge it, request changes to it, or close it. ## Contribution Prerequisites - 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). +**Before submitting your pull request** make sure the following requirements are fulfilled: + +- 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 +- Ensure the following test suites are passing: + - `yarn test:unit` + - `yarn test:front` +- Make sure your code lints by running `yarn lint`. +- If your contribution fixes an existing issue, please make sure to link it in your pull request. + ## 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._ - -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). - -Now, please follow the instructions below: - -#### 1. Fork the [repository](https://github.com/strapi/strapi) +### 1. Fork the [repository](https://github.com/strapi/strapi) [Go to the repository](https://github.com/strapi/strapi) and fork it using your own GitHub account. -#### 2. Clone from your repository +### 2. Clone your repository ```bash git clone git@github.com:YOUR_USERNAME/strapi.git ``` -#### 3. Install the dependencies +### 3. Install the dependencies -Go to the root of the repository and run the common setup: +Go to the root of the repository and run the setup: ```bash cd strapi yarn setup ``` -#### 4. Start the example application +### 4. Start the example application ```bash cd ./examples/getstarted @@ -96,7 +90,7 @@ yarn develop Make sure to read the [`getstarted` application README](./examples/getstarted/README.md) for more details. -#### 5. Running the administration panel in development mode +### 5. Running the administration panel in development mode Start the administration panel server for development: @@ -105,11 +99,11 @@ cd ./packages/core/admin yarn develop ``` -The administration panel should now be available at http://localhost:4000/admin +The administration panel should now be available at http://localhost:4000/admin. Make sure the example application (step 4) is still running. **Awesome! You are now able to contribute to Strapi.** -#### 6. Available commands +### 6. Available commands - `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). @@ -125,7 +119,7 @@ The administration panel should now be available at http://localhost:4000/admin --- -## Running the e2e tests +## Running the End-To-End (e2e) tests The end-to-end tests require a Strapi app to be able to run. You can generate a "test app" using `yarn test:generate-app `: @@ -135,9 +129,9 @@ $ yarn test:generate-app postgres $ yarn test:generate-app mysql ``` -You require a new app every time you run the tests. Otherwise, the test suite will fail. A script is available to make this process easier: `node test/e2e.js`. It'll 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:** +### Changing the database By default the script `test/e2e,js` creates an app that uses `sqlite`. But you can run the test suites using different databases: @@ -147,18 +141,18 @@ $ node test/e2e.js --db=postgres $ node test/e2e.js --db=mysql ``` -**Running the tests for the Community Editon (CE)** +### Running the tests for the Community Editon (CE)\*\* -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`: +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: ```bash $ STRAPI_DISABLE_EE=true node test/e2e.js $ STRAPI_DISABLE_EE=true yarn test:e2e ``` -**Specifying a license to use for the Enterprise Edition (EE) e2e tests** +### Specifying a license to use for the Enterprise Edition (EE) -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: +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= node test/e2e.js @@ -182,17 +176,17 @@ 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 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). + - 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). + - Ask a question on the [Strapi community forum](https://forum.strapi.io). - Your issue title is concise, on-topic and polite. -- You can and do provide steps to reproduce your issue. +- You provide steps to reproduce the issue. - 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 killed the Strapi server with CTRL+C and started it again. - - Make sure the application you are using to reproduce the issue has a clean `node_modules` directory, meaning: - - no dependencies are linked (e.g. you haven't run `yarn link`) - - that you haven't made any inline changes to files in the `node_modules` folder - - that you don't have any weird 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`. + - 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 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`. From 6b900e7573d7ab3126447b2bfd2750bfcab91522 Mon Sep 17 00:00:00 2001 From: Gustav Hansen Date: Fri, 11 Mar 2022 13:43:33 +0100 Subject: [PATCH 7/8] Docs: Bump require contributing node version to 14 --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99322608d4..7c7030d498 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,7 @@ The Strapi core team will review your pull request and either merge it, request ## Contribution Prerequisites -- 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 have [Node.js](https://nodejs.org/en/) at version >= v14 and <= v16 and [Yarn](https://yarnpkg.com/en/) at v1.2.0+ installed. - You are familiar with [Git](https://git-scm.com). **Before submitting your pull request** make sure the following requirements are fulfilled: From f435ad12cad601e4e8fbba15b91b96fddd420d4e Mon Sep 17 00:00:00 2001 From: Gustav Hansen Date: Fri, 11 Mar 2022 13:55:27 +0100 Subject: [PATCH 8/8] Docs: Improve wording of contributing guide --- CONTRIBUTING.md | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c7030d498..5d2de78792 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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= node test/e2e.js @@ -165,28 +166,28 @@ $ STRAPI_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`.