Skip to content

Latest commit

 

History

History
197 lines (128 loc) · 9.06 KB

CONTRIBUTING.md

File metadata and controls

197 lines (128 loc) · 9.06 KB
Raw

Contribute to Strapi

Strapi is an open-source project administered by the Akemona team. 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.

Open Development & Community Driven

Strapi is an open-source project. See the 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.

Feature Requests

Feature Requests by the community are highly encouraged. Please feel free to submit a feature request or to upvote 👍 an existing feature request in the ProductBoard.

RFCs

Some important changes in Strapi require some thoughts to be put into the 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.

Before contributing, you will probably have to create a RFC on this strapi/rfcs repo.

Code of Conduct

This project and everyone participating in it are governed by the Strapi Code of Conduct. By participating, you are expected to uphold this code. Please read the full text so that you can read which actions may or may not be tolerated.

Documentation

Pull requests relating to fixing documentation for the latest release should be directed towards the documentation repo. Please see the documentation contributing guide for more information on how to make the documentation pull request.

Bugs

We are using GitHub 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.

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 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!
  • Ensure the test suites are passing:
    • yarn test:unit
    • yarn test:front
  • Make sure your code lints (yarn lint).

Contribution Prerequisites

  • You have Node at >= v10 and <= v14 and Yarn at v1.2.0+.
  • You are familiar with Git.

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 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're using the required versions of Node.js and npm.

Then, please follow the instructions below:

1. Fork the repository

Go to the repository and fork it to your own GitHub account.

2. Clone from your repository

git clone [email protected]:YOUR_USERNAME/strapi.git

3. Install the dependencies

Go to the root of the repository.

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.

cd strapi/examples/getstarted && yarn develop

Read the getstarted application README here for more details.

5. Running the administration panel in development mode

Start the administration panel server for development

cd strapi/packages/strapi-admin
yarn develop

The administration panel will be available at http://localhost:4000/admin

Awesome! You are now able to contribute to Strapi.

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).
  • yarn setup installs the dependencies.
  • yarn lint lints the codebase.
  • yarn test:clean removes the coverage.
  • yarn test:front runs the front-end related tests.
  • yarn test:front:watch runs an interactive test watcher for the front-end.
  • yarn test:snyk checks the dependencies vulnerabilities.
  • yarn test:unit runs the back-end unit tests.
  • yarn test:e2e runs an end-to-end test suite.
  • yarn test:generate-app generates a test application.
  • yarn test:start-app starts the test application.

Running the 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 <database>:

$ yarn test:generate-app sqlite
$ yarn test:generate-app mongo
$ 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.

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:

$ node test/e2e.js --db=sqlite
$ node test/e2e.js --db=mongo
$ node test/e2e.js --db=postgres
$ node test/e2e.js --db=mysql

Running the tests for the 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:

$ 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

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:

$ STRAPI_LICENSE=<license> node test/e2e.js
$ STRAPI_LICENSE=<license> yarn test:e2e

Miscellaneous

Repository Organization

We chose to use a monorepo design that exploits Yarn Workspaces in the way React or Babel does. This allows the community to easily 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 so that you're 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 have already searched for related 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:
  • Your issue title is concise, on-topic and polite.
  • You can and do provide steps to reproduce your 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 is respected.
    • Make sure your issue body is readable and well formatted.
    • 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 npm 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 && npm cache clear && npm install.