Skip to content

Latest commit

 

History

History
195 lines (127 loc) · 9.22 KB

CONTRIBUTING.md

File metadata and controls

195 lines (127 loc) · 9.22 KB
Raw

Contribute to Strapi

Strapi is an open-source project administered by the Strapi team. We appreciate your interest and efforts to contribute to Strapi. See the LICENSE licensing information. All work done is available on GitHub.

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

Feature Requests by the community are highly encouraged. Feel free to submit a new one or upvote an existing feature request on ProductBoard.

Request For Comments (RFC)

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.

A Request For Comments has to be created on the strapi/rfcs repository.

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 it. Make sure to read the full text to understand which type of actions may or may not be tolerated.

Contributor License Agreement (CLA)

Individual contribution

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, or our CLA bot will automatically ask you to sign before merging the pull request.

Company contribution

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 [email protected].

Documentation

Pull requests related to fixing documentation for the latest release should be directed towards the documentation repository. Please follow the documentation contributing guide for more information.

Bugs

Strapi is using GitHub 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, or close it.

Contribution Prerequisites

  • You have Node.js at version >= v14 and <= v18 and Yarn at v1.2.0+ installed.
  • You are familiar with Git.

Before submitting your pull request make sure the following requirements are fulfilled:

  • Fork the repository and create your new branch from main.
  • 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

1. Fork the repository

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

2. Clone your repository

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

3. Install the dependencies

Go to the root of the repository and run the setup:

cd strapi
yarn setup

4. Start the example application

cd ./examples/getstarted
yarn develop

Make sure to read the getstarted application README for more details.

5. Running the administration panel in development mode

Start the administration panel server for development:

cd ./packages/core/admin
yarn develop

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

  • 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 dependencies.
  • yarn lint lints the codebase.
  • 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.
  • yarn test:generate-app generates a test application.
  • yarn test:start-app starts the test application.

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

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

The script takes a path as optional argument (e.g. node test/e2e.js path/to/test). Options for jest can be passed using the double-dash notion: e.g. to update snapshots node test/e2e.js -- -u.

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=postgres
$ node test/e2e.js --db=mysql

Running the tests for the Community Editon (CE)**

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:

$ 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)

The Enterprise Edition tests need a valid license to run correctly. To specify a license, you can use the environment variable STRAPI_LICENSE:

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

Miscellaneous

Repository Organization

We chose to use a monorepo design using Yarn Workspaces in the way React or Babel 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, the master branch can move faster than the release cycle. Therefore check the releases on npm 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 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 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 is respected.
    • Make sure your issue body is readable and well formatted.
    • 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 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. 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.