|
1 | 1 | # Contributing
|
2 | 2 |
|
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) |
0 commit comments