github/directus
1
0
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-01-23 08:47:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Wrap tip in prettier ignore, format using prettier

Browse Source
This commit is contained in:
rijkvanzanten
2021-01-12 10:00:03 -05:00
parent 74e6abb064
commit 3572e40e40
1 changed files with 49 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
docs/getting-started/contributing.md
View File

@@ -1,16 +1,14 @@
# 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](https://directus.chat).
> 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](https://directus.chat).
## 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), API Specification (OpenAPI), and other smaller
packages used internally. Directus follows a monorepo design similar to React or Babel — to learn
more about our monorepo's design and structure, see our [Codebase Overview](#codebase-overview)
below.
Our Node.js repository is located at `directus/directus` and houses the Admin App (Vue.js 3), Node.js API, project
documentation (Markdown), API Specification (OpenAPI), and other smaller packages used internally. Directus follows a
monorepo design similar to React or Babel — to learn more about our monorepo's design and structure, see our
[Codebase Overview](#codebase-overview) below.
To contribute to the project, please follow the instructions located within our GitHub repository's
[contributing.md file](https://github.com/directus/directus/blob/main/contributing.md).
@@ -27,9 +25,8 @@ 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](https://github.com/directus/directus/discussions/category_choices) or
upvote [existing submissions](https://github.com/directus/directus/discussions) all via our GitHub
Discussions board.
[submit a feature request](https://github.com/directus/directus/discussions/category_choices) or upvote
[existing submissions](https://github.com/directus/directus/discussions) all via our GitHub Discussions board.
<!-- prettier-ignore-start -->
::: warning The 80/20 Rule
@@ -42,58 +39,52 @@ 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](https://directus.chat). This process is relatively
informal, but ensures proper alignment, and helps avoid squandered development time by contributors.
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](https://directus.chat). 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](https://github.com/directus/directus/issues/new) via GitHub Issues. Please
ensure the following for all submissions:
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](https://github.com/directus/directus/issues/new) 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
- 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
Please make sure to include all information required to reproduce your exact setup and issue in the
issue report.
Please make sure to include all information required to reproduce your exact setup and issue in the issue report.
## 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: [security@directus.io](mailto:security@directus.io). We will
then open a [GitHub Security Advisory](https://github.com/directus/directus/security/advisories) for
tracking the fix.
If you believe you have discovered a security issue within a Directus product or service, please reach out to us
directly over email: [security@directus.io](mailto:security@directus.io). We will then open a
[GitHub Security Advisory](https://github.com/directus/directus/security/advisories) 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:
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
- 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](https://github.com/directus/directus/blob/main/code_of_conduct.md) 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.
The Directus [Code of Conduct](https://github.com/directus/directus/blob/main/code_of_conduct.md) 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](/guides/installation/cli) and you are familiar with Git.
Before getting started, ensure you your local environment meets our [minimum requirements](/guides/installation/cli) and
you are familiar with Git.
### 1. Fork the Directus repository
@@ -119,9 +110,8 @@ npm install
### 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
root of the project:
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 root of the project:
```bash
npm run cli -- init
@@ -135,12 +125,14 @@ Run the following command from the root directory.
npm run dev
```
<!-- prettier-ignore-start -->
::: If you encounter errors during this installation process, make sure your node version meets the [minimum requirements](/guides/installation/cli) :::
<!-- prettier-ignore-end -->
### 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).
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).
## Submitting a Pull-Request
@@ -150,8 +142,7 @@ Please read our docs on the [RFC process](#rfcs).
### 2. Update relevant docs
Before submitting any pull-requests, ensure that any relevant documentation (included in this same
repo) is updated.
Before submitting any pull-requests, ensure that any relevant documentation (included in this same repo) is updated.
### 3. Push your changes
@@ -161,12 +152,11 @@ 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.
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.
Now our core staff will review your contribution and either merge it, or request that you to make changes.
## Codebase Overview