mirror of
https://github.com/directus/directus.git
synced 2026-01-24 11:37:57 -05:00
b67c4cd2e2
* Move Debug Docs from Wiki to Docs * Add Copyright License Agreement to Docs * Start Reformat0 of Codebase Overview * Add Package Documentation to Codebase Overview * Add Link to Blackbox Folder * Add Changesets to Pull Request Process * Add Component Library Tips * Fix Spelling * Fix dictionary * Create thick-glasses-bake.md --------- Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
48 lines
3.1 KiB
Markdown
48 lines
3.1 KiB
Markdown
# Pull Request Process
|
|
|
|
Pull Requests (PRs) are a fantastic way to contribute back to the project. It's one of the fastest ways to see a bug fix
|
|
or new feature you care about land in the platform.
|
|
|
|
Reviewing and maintaining community submitted code is a very time consuming process. To ensure the core team can give
|
|
every PR the tender love and care it deserves, and not let valuable PRs go stale, we require that:
|
|
|
|
**Every pull request must be in answer to an existing open [Issue](https://github.com/directus/directus/issues).**
|
|
|
|
We use [GitHub Issues](https://github.com/directus/directus/issues) as a living to-do list of tasks to work on next.
|
|
Each PR resolving a related issue ensures that it aligns with the core team's planning and long-term goals. Please leave
|
|
a comment on the issue related to your PR so you can be marked as the assignee. This ensures no one else will
|
|
accidentally work on the same issue at the same time.
|
|
|
|
## Choosing What to Implement
|
|
|
|
We welcome PRs for any [Issue](https://github.com/directus/directus/issues). Issues labeled
|
|
["Community"](https://github.com/directus/directus/issues?q=is:issue+is:open+label:Community) have been identified as
|
|
good improvements or fixes for community members, as they're often a little more scoped in what they affect. This in
|
|
turn makes it easier to implement the change and review the work. Issues labeled
|
|
["Good First Issue"](https://github.com/directus/directus/issues?q=is:issue+is:open+label:%22Good+First+Issue%22) are
|
|
typically easier to resolve for those who haven't contributed to the codebase before, and are therefore a great starting
|
|
point.
|
|
|
|
## Implementing an Accepted Feature Request
|
|
|
|
If you're looking to implement a feature request that hasn't been converted to an issue yet, please contact the core
|
|
team through a comment on the feature request before starting work. There's probably a good reason it isn't
|
|
ready-to-be-implemented yet (unknown timelines, conflicts with other projects, blockers, etc). By collaborating early,
|
|
we ensure your PR can be merged as efficiently as possible!
|
|
|
|
## Copyright License Agreement (CLA)
|
|
|
|
All code contributors are required to sign the Contributor License Agreement (CLA). When you start a pull request, a
|
|
GitHub Action will prompt you to review the CLA and sign it by adding your name to
|
|
[contributors.yml](https://github.com/directus/directus/blob/main/contributors.yml). To clarify the intellectual
|
|
property rights in the project and any Contributions, Directus requires that You accept the
|
|
[Contributor License Agreement](https://github.com/directus/directus/blob/main/cla.md). This license is for Your
|
|
protection as a contributor as well as the protection of Directus, recipients of software distributed or made available
|
|
by Directus, and other contributors; it does not change your rights to use your own Contributions for any other purpose.
|
|
|
|
## Changesets
|
|
|
|
To properly generate changelogs and determine the right version number after a change is merged, we rely on
|
|
[changesets](https://github.com/changesets/changesets). Each pull request should include a changeset that describes
|
|
whether the change is a patch/minor/major version bump, and describe what the change is.
|