6.1 KiB
Contributing
Our team truly appreciates every single pull-request, bug report, and feature request made by our community. If you have any questions along the way, please reach out to our Core team on Discord.
Node Monorepo
Our Node.js repository is located at directus/directus and houses the Admin App (vue.js 3), Node.js API, project documentation (markdown), and API Specification (OpenAPI). Directus follows a monorepo design similar to React or Babel — to learn more about our monorepo's design and structure, see our Codebase Overview below.
To contribute to the project, please follow the instructions located within our GitHub repoitory's contributing.md file.
::: PHP API Port
While the Node.js version of Directus defines the official specification and is our team's primary focus, we also support a community-lead PHP API port in Laravel. This secondary codebase is located in a separate git repository at directus/php.
:::
Feature Requests
Feature requests are a great way to let our team know what should be prioritized next. You can submit a feature request or upvote existing submissions all via our GitHub Discussions board.
:::warning The 80/20 Rule To keep the Directus codebase as clean and simple as possible, we will only consider approving features that we feel at least 80% of our user-base will find valuable. If your feature request falls within the 20% range, it is considered an edge-case and should be implemented as an extension. :::
RFCs
Some Directus features/fixes may require additional design, strategy, and/or discussion before beginning work. For these notable pull-requests, you should first submit an RFC (Request For Comments) to our core team via Discord. This process is relatively informal, but ensures proper alignment, and helps avoid squandered development time by contributors.
Bug Reporting
Reporting any bugs you come across is an invaluable part of helping keep Directus stable. After confirming a similar issue doesn't already exist, you can submit a bug report via GitHub Issues. Please ensure the following for all submissions:
- You are experiencing an actual bug, not a configuration issue
- You are not asking a question or requesting a new feature
- You have checked that no similar issue already exists
- You have entered a clear and concise title
- You have followed the issue template, with stack details and steps to reproduce
- You have already tried the following troubleshooting steps:
- You are on the latest version of Directus
- You have stopped (
CTRL+C) and restarted the server - You have confirmed the issue is not related to your own custom code
- Dev Only: You have cleared and reinstalled all dependencies
Reporting Security Vulnerabilities
If you believe you have discovered a security issue within a Directus product or service, please reach out to us directly over email: support@directus.io. We will then open a GitHub Security Advisory for tracking the fix.
We value the members of the independent security research community who find security vulnerabilities and work with our team so that proper fixes can be issued to users. Our policy is to credit all researchers in the fix's release notes. In order to receive credit, security researchers must follow responsible disclosure practices, including:
- They do not publish the vulnerability prior to the Directus team releasing a fix for it
- They do not divulge exact details of the issue, for example, through exploits or proof-of-concepts
Code of Conduct
The Directus Code of Conduct is one of the ways we put our values into practice. We expect all of our staff, contractors and contributors to know and follow this code.
Development Workflow
Before getting started, ensure you your local environment meets our minimum requirements and you are familiar with Git.
1. Fork the Directus repository
Go to the repository and fork it to your GitHub account.
2. Clone from your repository
git clone git@github.com:YOUR-USERNAME/next.git
3. Make a new branch
git checkout -b YOUR-BRANCH-NAME
4. Install the dependencies
npm install
npm run setup
5. Setup the Database & Env File
For this step, you'll need to already have a SQL database up-and-running, otherwise you can only use the SQLite driver, which will create the database for you. Run the following command from within the /api directory.
./cli.js init
6. Start the development server
Run the following command from the root directory.
npm run dev
7. Make your fixes/changes
At this point you are ready to start working on Directus! Before diving in however, it's worth reading through our docs on submitting a pull-request.
Submitting a Pull-Request
1. Submit an RFC (if needed)
Please read our docs on the RFC process.
2. Update relevant docs
Before submitting any pull-requests, ensure that any relevant documentation (included in this same repo) is updated.
3. Push your changes
git push -u origin YOUR-BRANCH-NAME
Submit a pull-request
Once you push the changes to your repo, the "Compare & pull request" button will appear in GitHub. Click it and you'll be taken to a screen where you can fill in the appropriate details. Finally, open the pull request by clicking the "Create pull request" button.
Now our core staff will review your contribution and either merge it, or request that you to make changes.
Codebase Overview
/api
Contains the Directus API (REST+GraphQL), written in node.js.
/app
Contains the Directus Admin App, written in vue.js 3.
/docs
Contains all the platform's documentation, written in markdown with additional VuePress formatting.