Skip to content

Commit 5cf2c0d

Browse files
rijkvanzantenpaescujphazonoverload
authored
Add feature request workflow to contributing guidelines (directus#18528)
* Point to docs hosted C&C * Point to hosted contributing guidelines * Remove outdated information This is incorrect, so does more harm than good imo * Update contributing guidelines to add feature requests flow * Lil nicer to read * Add missing words to dict * Update docs/contributing/code-of-conduct.md Co-authored-by: Pascal Jufer <[email protected]> * Update docs/contributing/introduction.md Co-authored-by: Pascal Jufer <[email protected]> * Update docs/contributing/pull-request-process.md Co-authored-by: Pascal Jufer <[email protected]> * Update docs/contributing/feature-request-process.md Co-authored-by: Pascal Jufer <[email protected]> * Update docs/contributing/feature-request-process.md Co-authored-by: Kevin Lewis <[email protected]> * Update docs/contributing/pull-request-process.md Co-authored-by: Kevin Lewis <[email protected]> * Fix license/version for new packages (directus#18536) * Standardize TSConfig use (directus#18538) * Use tsconfig.prod.json in packages * Use prod tsconfig in api * Install node types in storage * Use vitest run instead of --watch=false (directus#18540) * Remove local file * Revert "Use vitest run instead of --watch=false (directus#18540)" (directus#18542) This reverts commit 97f0af6. * Setup boilerplate for data (directus#18541) * Setup boilerplate for data * Update readme * Fix directory link * Final tweaks from Ben --------- Co-authored-by: Pascal Jufer <[email protected]> Co-authored-by: Kevin Lewis <[email protected]>
1 parent 93e5421 commit 5cf2c0d

9 files changed

+193
-329
lines changed

code_of_conduct.md

+3-60
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,4 @@
1-
# Contributor Covenant Code of Conduct
1+
# Code of Conduct
22

3-
## Our Pledge
4-
5-
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
6-
participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
7-
disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education,
8-
socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
9-
10-
## Our Standards
11-
12-
Examples of behavior that contributes to creating a positive environment include:
13-
14-
- Using welcoming and inclusive language
15-
- Being respectful of differing viewpoints and experiences
16-
- Gracefully accepting constructive criticism
17-
- Focusing on what is best for the community
18-
- Showing empathy towards other community members
19-
20-
Examples of unacceptable behavior by participants include:
21-
22-
- The use of sexualized language or imagery and unwelcome sexual attention or advances
23-
- Trolling, insulting/derogatory comments, and personal or political attacks
24-
- Public or private harassment
25-
- Publishing others' private information, such as a physical or electronic address, without explicit permission
26-
- Other conduct which could reasonably be considered inappropriate in a professional setting
27-
28-
## Our Responsibilities
29-
30-
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
31-
appropriate and fair corrective action in response to any instances of unacceptable behavior.
32-
33-
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
34-
issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
35-
contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
36-
37-
## Scope
38-
39-
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
40-
project or its community. Examples of representing a project or community include using an official project e-mail
41-
address, posting via an official social media account, or acting as an appointed representative at an online or offline
42-
event. Representation of a project may be further defined and clarified by project maintainers.
43-
44-
## Enforcement
45-
46-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
47-
[email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed
48-
necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to
49-
the reporter of an incident. Further details of specific enforcement policies may be posted separately.
50-
51-
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
52-
repercussions as determined by other members of the project's leadership.
53-
54-
## Attribution
55-
56-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
57-
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
58-
59-
[homepage]: https://www.contributor-covenant.org
60-
61-
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
3+
Please see our code of conduct on
4+
[https://docs.directus.io/contributing/code-of-conduct](https://docs.directus.io/contributing/code-of-conduct)

contributing.md

+2-122
Original file line numberDiff line numberDiff line change
@@ -1,124 +1,4 @@
11
# Contributing
22

3-
Heya! Welcome to Directus, and thank you for taking the time to contribute back to Open Source Software! ❤️ We want
4-
everybody to be able to contribute to Directus, no matter your background or expertise. In order to facilitate that,
5-
we've put together a couple tips and tricks below. Our team truly appreciates every single contributor, community
6-
member, GitHub star, pull-request, bug report, and feature request. Keeping Directus completely open-source is our way
7-
of saying: **Thank you!**
8-
9-
> We're here to help!
10-
>
11-
> If you have _any_ questions along your contributor journey, please feel free to come chat with us on
12-
> [our Discord server](https://directus.chat).
13-
14-
## Code of Conduct
15-
16-
**The Directus [Code of Conduct](https://github.com/directus/directus/blob/main/code_of_conduct.md) is one of the ways
17-
we put our values into practice. We expect all of our staff, contractors and contributors to know and follow this
18-
code.**
19-
20-
**Our contributors and maintainers work extremely hard to build Directus as premium open-source software. Please be
21-
respectful of those efforts throughout our ecosystem. Trolling, harassing, insulting, or other unacceptable behavior by
22-
participants will not be tolerated.**
23-
24-
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
25-
participation in our project and community a harassment-free experience for everyone, regardless of age, body size,
26-
disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education,
27-
socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
28-
29-
Examples of behavior that contributes to creating a positive environment include:
30-
31-
- Using welcoming and inclusive language
32-
- Being respectful of differing viewpoints and experiences
33-
- Gracefully accepting constructive criticism
34-
- Focusing on what is best for the community
35-
- Showing empathy towards other community members
36-
37-
**Before continuing, please take a moment to read our full
38-
[Code of Conduct](https://github.com/directus/directus/blob/main/code_of_conduct.md).**
39-
40-
## Ways to Contribute
41-
42-
### Reporting Bugs
43-
44-
If you happen to run into a bug, please post an Issue on our main GitHub Issue board:
45-
https://github.com/directus/directus/issues
46-
47-
Please be as explicit and detailed as you can in the bug report. The more information available, the easier it is for
48-
other contributors to help you find the solution or fix. Consider adding a schema snapshot file, or a database dump.
49-
50-
### Leaving Feedback
51-
52-
If you have a great idea for an improvement of the platform, or any other feedback, please make sure to open a new
53-
Discussion on our GitHub Discussions board: https://github.com/directus/directus/discussions
54-
55-
### Document the Project
56-
57-
The [Directus Docs](https://github.com/directus/docs) are living documents that can always be improved on. Notice any
58-
parts of the docs in dire need of some tender love and care? Feel free to open a Pull Request!
59-
60-
### Helping Others
61-
62-
The Directus community is growing quickly, which also means there's more and more people that have questions. Helping
63-
out your fellow developers by answering questions on [Discord](https://directus.chat) or
64-
[GitHub Discussions](https://github.com/directus/directus/discussions/categories/q-a) is a great way to help the
65-
project.
66-
67-
### Pull Requests
68-
69-
Issues marked "Community" are ready to be implemented by anybody at any point! If you're looking to implement an issue
70-
that doesn't have that label, please make sure to ping the maintainers before getting started!
71-
72-
#### Contributor License Agreement
73-
74-
All code contributors are required to sign the Contributor License Agreement (CLA). When you start a pull request, a
75-
GitHub Action will prompt you to review the CLA and sign it by adding your name to contributors.yml
76-
77-
#### Changesets
78-
79-
To properly generate changelogs and determine the right version number after a change is merged, we rely on
80-
[changesets](https://github.com/changesets/changesets). Each PR should include a changeset that describes whether the
81-
change is a patch/minor/major version bump, and describe what the change is.
82-
83-
#### Bug Fixes
84-
85-
We treat Issues on the main repo as actionable items we want to get done. This also means that we welcome PRs for any
86-
Issue that has been labeled either "Bug", "Improvement", or "New Feature". Labeled issues are bugs or new features that
87-
have been triaged, accepted, and are ready to be implemented.
88-
89-
#### Implementing Features
90-
91-
With the continuous growth of Directus, more and more people are relying on Directus for (critical) data workloads in
92-
various use cases. This means we need to be careful with any changes that might affect the stability, security,
93-
performance, or scalability of Directus. For this reason, it's important that any new feature is properly thought
94-
through and discussed before being implemented.
95-
96-
Before you start writing code to implement your new feature idea, please read through and understand our triaging
97-
process for new features before diving in. While we encourage and appreciate every code contribution, please understand
98-
that we can't merge every suggested code change.
99-
100-
##### Triaging Process
101-
102-
Feature Request Discussions that are deemed ready to be implemented with the discussed implementation details are marked
103-
"Accepted" and converted into an Issue, at which point the feature is ready to be implemented.
104-
105-
New feature ideas reported directly to issues might be converted into a Discussion for further triaging at
106-
[the core team](https://github.com/orgs/directus/people)'s discretion first. This is often due to a lack of detail, or
107-
lack of proven interest.
108-
109-
Each Pull Request that comes in is required to resolve [an open Issue](https://github.com/directus/directus/issues) that
110-
is labeled "Bug", "Improvement", or "New Feature". This ensures that any code change made implements a known actionable
111-
item, be it a feature or otherwise.
112-
113-
### Reporting Security Vulnerabilities
114-
115-
If you believe you have discovered a security issue within a Directus product or service, please reach out to us
116-
directly over email: [[email protected]](mailto:[email protected]). We will then open a
117-
[GitHub Security Advisory](https://github.com/directus/directus/security/advisories) for tracking the fix.
118-
119-
We value the members of the independent security research community who find security vulnerabilities and work with our
120-
team so that proper fixes can be issued to users. Our policy is to credit all researchers in the fix's release notes. In
121-
order to receive credit, security researchers must follow responsible disclosure practices, including:
122-
123-
- They do not publish the vulnerability prior to the Directus team releasing a fix for it
124-
- They do not divulge exact details of the issue, e.g., through exploits or proof-of-concepts
3+
Please see our contributing guidelines on
4+
[https://docs.directus.io/contributing/introduction](https://docs.directus.io/contributing/introduction)

docs/.vitepress/config.js

+2-10
Original file line numberDiff line numberDiff line change
@@ -603,21 +603,13 @@ function sidebar() {
603603
link: '/contributing/introduction',
604604
text: 'Introduction',
605605
},
606-
{
607-
link: '/contributing/codebase-overview',
608-
text: 'Codebase Overview',
609-
},
610606
{
611607
link: '/contributing/running-locally',
612608
text: 'Running Locally',
613609
},
614610
{
615-
link: '/contributing/github-ci',
616-
text: 'GitHub CI',
617-
},
618-
{
619-
link: '/contributing/translations',
620-
text: 'Translating the App',
611+
link: '/contributing/codebase-overview',
612+
text: 'Codebase Overview',
621613
},
622614
],
623615
},

docs/contributing/code-of-conduct.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
6+
participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
7+
disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education,
8+
socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
9+
10+
## Our Standards
11+
12+
Examples of behavior that contributes to creating a positive environment include:
13+
14+
- Using welcoming and inclusive language
15+
- Being respectful of differing viewpoints and experiences
16+
- Gracefully accepting constructive criticism
17+
- Focusing on what is best for the community
18+
- Showing empathy towards other community members
19+
20+
Examples of unacceptable behavior by participants include:
21+
22+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
23+
- Trolling, insulting/derogatory comments, and personal or political attacks
24+
- Public or private harassment
25+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
26+
- Other conduct which could reasonably be considered inappropriate in a professional setting
27+
28+
## Our Responsibilities
29+
30+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
31+
appropriate and fair corrective action in response to any instances of unacceptable behavior.
32+
33+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
34+
issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
35+
contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
36+
37+
## Scope
38+
39+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
40+
project or its community. Examples of representing a project or community include using an official project e-mail
41+
address, posting via an official social media account, or acting as an appointed representative at an online or offline
42+
event. Representation of a project may be further defined and clarified by project maintainers.
43+
44+
## Enforcement
45+
46+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
47+
[email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed
48+
necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to
49+
the reporter of an incident. Further details of specific enforcement policies may be posted separately.
50+
51+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
52+
repercussions as determined by other members of the project's leadership.
53+
54+
## Attribution
55+
56+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
57+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
58+
59+
[homepage]: https://www.contributor-covenant.org
60+
61+
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Request a Feature
2+
3+
If you have a great idea for an improvement of the platform, or any other feedback, please make sure to open a new
4+
Discussion on [our GitHub Discussions board](https://github.com/directus/directus/discussions).
5+
6+
## Opening a New Feature Request
7+
8+
New feature requests can be opened under the Feature Requests section of
9+
[GitHub Discussions](https://github.com/directus/directus/discussions). Feature Requests follow a Request-for-Comment
10+
(RFC) format that allows anybody to fully understand what you're proposing, and help speed up the review and triaging
11+
process.
12+
13+
**While the form might seem intimidating at first, please do fill out all sections with as much detail as possible. The
14+
less ambiguity around _how_ a feature should work, the easier it is to review, triage, and develop a feature.**
15+
16+
## Review Process
17+
18+
Once a feature request gets 15 or more upvotes, it will be moved to the "Under Review" status at which point the
19+
Directus Core team will review it, and decide if it will be approved, denied, or if changes are required. If the feature
20+
request is accepted, it will be moved to the "Approved Requests" status, at which point the feature is ready to be
21+
implemented.
22+
23+
However, if a feature request doesn't reach at least 15 upvotes within 3 months of it being created, it will be closed
24+
due to a lack of community interest.
25+
26+
## Implementing Accepted Feature Requests
27+
28+
It's important to note that Accepted Feature Requests are _not_ an ordered list of things that will be worked on next.
29+
Even though we strive to prioritize what's being worked on based on community feedback, it's likely that there will be
30+
times when a feature request is blocked by something else that's prioritized by the team. The implementation of accepted
31+
feature request is triaged based on a combination of popularity, team availability, timelines, scope of the feature, and
32+
overall project goals.

docs/contributing/github-ci.md

-55
This file was deleted.

0 commit comments

Comments
 (0)