mirror of
https://github.com/glitch-soc/mastodon.git
synced 2026-03-28 17:50:01 +01:00
Update contributing docs (#38125)
Signed-off-by: Andy Piper <andypiper@users.noreply.github.com>
This commit is contained in:
@@ -11,6 +11,8 @@ You can contribute in the following ways:
|
|||||||
|
|
||||||
Please review the org-level [contribution guidelines] for high-level acceptance
|
Please review the org-level [contribution guidelines] for high-level acceptance
|
||||||
criteria guidance and the [DEVELOPMENT] guide for environment-specific details.
|
criteria guidance and the [DEVELOPMENT] guide for environment-specific details.
|
||||||
|
You should also read the project's [AI Contribution Policy] to understand how we approach
|
||||||
|
AI-assisted contributions.
|
||||||
|
|
||||||
## API Changes and Additions
|
## API Changes and Additions
|
||||||
|
|
||||||
@@ -41,7 +43,7 @@ reviewed and merged into the codebase.
|
|||||||
|
|
||||||
Our time is limited and PRs making large, unsolicited changes are unlikely to
|
Our time is limited and PRs making large, unsolicited changes are unlikely to
|
||||||
get a response. Changes which link to an existing confirmed issue, or which come
|
get a response. Changes which link to an existing confirmed issue, or which come
|
||||||
from a "help wanted" issue or other request are more likely to be reviewed.
|
from a "help wanted" issue or other request, are more likely to be reviewed.
|
||||||
|
|
||||||
The smaller and more narrowly focused the changes in a PR are, the easier they
|
The smaller and more narrowly focused the changes in a PR are, the easier they
|
||||||
are to review and potentially merge. If the change only makes sense in some
|
are to review and potentially merge. If the change only makes sense in some
|
||||||
@@ -89,3 +91,4 @@ and API docs. Improvements are made via PRs to the [documentation repository].
|
|||||||
[keepachangelog]: https://keepachangelog.com/en/1.0.0/
|
[keepachangelog]: https://keepachangelog.com/en/1.0.0/
|
||||||
[Mastodon documentation]: https://docs.joinmastodon.org
|
[Mastodon documentation]: https://docs.joinmastodon.org
|
||||||
[SECURITY]: SECURITY.md
|
[SECURITY]: SECURITY.md
|
||||||
|
[AI Contribution Policy]: https://github.com/mastodon/.github/blob/main/AI_POLICY.md
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Before starting local development, read the [CONTRIBUTING] guide to understand
|
Before starting local development, read the [CONTRIBUTING] guide to understand
|
||||||
what changes are desirable and what general processes to use.
|
what changes are desirable and what general processes to use. You should also read the project's [AI Contribution Policy] to understand how we approach AI-assisted contributions.
|
||||||
|
|
||||||
## Environments
|
## Environments
|
||||||
|
|
||||||
@@ -103,3 +103,4 @@ development environment configured with the software needed for this project.
|
|||||||
[GitHub Codespaces]: https://docs.github.com/en/codespaces
|
[GitHub Codespaces]: https://docs.github.com/en/codespaces
|
||||||
[Homebrew]: https://brew.sh
|
[Homebrew]: https://brew.sh
|
||||||
[Mastodon docs]: https://docs.joinmastodon.org/dev/setup/#working-with-emails-in-development
|
[Mastodon docs]: https://docs.joinmastodon.org/dev/setup/#working-with-emails-in-development
|
||||||
|
[AI Contribution Policy]: https://github.com/mastodon/.github/blob/main/AI_POLICY.md
|
||||||
|
|||||||
Reference in New Issue
Block a user