Strapi is an open-source project administered by the Strapi 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.
Strapi is open-source under the MIT license. 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 by the community are highly encouraged. Please feel free to submit a feature request or to upvote 👍 an existing feature request in the ProductBoard.
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.
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.
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
).
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.
git clone [email protected]:YOUR_USERNAME/strapi.git
Go to the root of the repository.
cd strapi && yarn setup
Go to the getstarted application
cd strapi/examples/getstarted
yarn develop
The server (API) is available at http://localhost:1337
⚠️ If you've followed the recommended setup, you should not be able to reach the administration panel at http://localhost:1337/admin.
Start the administration panel server
cd strapi/packages/strapi-admin
yarn develop
The administration panel is available at http://localhost:4000/admin
Awesome! You are now able to contribute to Strapi.
yarn watch
starts yarn watch in all packages.yarn build
builds thestrapi-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.
Changing the database:
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
We chose to 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.
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:
- Refer to the official Strapi documentation.
- Ask a member of the community in the Strapi Slack Community.
- Ask a question on StackOverflow.
- 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 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
.
- no dependencies are linked (e.g. you haven't run