Skip to content

Commit 058b6ad

Browse files
authored
Update contribution guidelines towards more focused, actionable contributions (#2133)
1 parent 2f23508 commit 058b6ad

File tree

3 files changed

+40
-20
lines changed

3 files changed

+40
-20
lines changed

CODE_OF_CONDUCT.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,28 @@ diverse, inclusive, and healthy community.
1717
Examples of behavior that contributes to a positive environment for our
1818
community include:
1919

20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
20+
* Demonstrating empathy and kindness toward other people.
21+
* Being respectful of differing opinions, viewpoints, and experiences.
22+
* Giving and gracefully accepting constructive feedback.
2323
* Accepting responsibility and apologizing to those affected by our mistakes,
24-
and learning from the experience
24+
and learning from the experience.
2525
* Focusing on what is best not just for us as individuals, but for the
26-
overall community
26+
overall community.
27+
* Contributing constructive, concise, and actionable feedback that helps improve the project.
28+
* Keeping contributions relevant to the plugin's purpose and scope.
2729

2830
Examples of unacceptable behavior include:
2931

3032
* The use of sexualized language or imagery, and sexual attention or
31-
advances of any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
33-
* Public or private harassment
33+
advances of any kind.
34+
* Trolling, insulting or derogatory comments, and personal or political attacks.
35+
* Public or private harassment.
3436
* Publishing others' private information, such as a physical or email
35-
address, without their explicit permission
37+
address, without their explicit permission.
38+
* Submitting off-topic issues, excessive feature requests, or contributions
39+
that don't align with the project's goals.
3640
* Other conduct which could reasonably be considered inappropriate in a
37-
professional setting
41+
professional setting.
3842

3943
## Enforcement Responsibilities
4044

CONTRIBUTING.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,15 @@ Developers of all levels can help — whether you can barely recognize a filter
66

77
## Create Bug Reports
88

9-
If you find a bug, please [file a GitHub issue](https://github.com/Automattic/wordpress-activitypub/issues/). If you have write access, add the appropriate labels.
9+
If you find a bug, please use our [bug report form](https://github.com/Automattic/wordpress-activitypub/issues/new?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen&template=bug_report.yml). This helps us gather the information we need efficiently.
1010

11-
If you’re filing a bug, specific steps to reproduce are helpful. Please include the URL of the page that has the bug, along with what you expected to see and what happened instead.
11+
**Keep your bug reports focused and actionable:**
12+
- Include specific steps to reproduce the issue.
13+
- Provide the URL of the page that has the bug.
14+
- Describe what you expected to see and what happened instead.
15+
- Stay within the plugin's scope—issues unrelated to ActivityPub functionality may be closed.
16+
17+
If you have write access, add the appropriate labels.
1218

1319
## Write and submit a patch
1420

@@ -23,9 +29,16 @@ If you'd like to contribute but don't know where to get started, you can take a
2329
- ["Good First Issues"](https://github.com/Automattic/wordpress-activitypub/labels/%5BType%5D%20Good%20First%20Issue) are a good entry point to get familiar with ActivityPub plugin's code base.
2430
- All issues labeled with [the "Good For Community" label](https://github.com/Automattic/wordpress-activitypub/issues?q=is%3Aopen+sort%3Aupdated-desc+label%3A%22Good+For+Community%22) are fair game. That's a great way to contribute new features and fix small issues within the ActivityPub plugin.
2531

26-
### We’re Here To Help
32+
### We're Here To Help
33+
34+
We encourage you to ask for help at any point. We want your first experience with the ActivityPub plugin to be a good one, so don't be shy.
35+
36+
**For questions and discussions:**
37+
- Use [GitHub Discussions](https://github.com/Automattic/wordpress-activitypub/discussions) for feature ideas, general questions, and open-ended topics.
38+
- Create issues only for specific bugs or concrete enhancement proposals.
39+
- Keep questions concise and directly related to the plugin.
2740

28-
We encourage you to ask for help at any point. We want your first experience with the ActivityPub plugin to be a good one, so don’t be shy. If you’re wondering why something is the way it is, or how a decision was made, please create an issue and prefix it with “Question:”.
41+
This helps us organize feedback effectively and ensures your questions get the right attention.
2942

3043
## Translate the plugin
3144

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,17 @@ If you need help, [check out the support forums on WordPress.org](https://wordpr
2929

3030
## Contribute
3131

32-
Thank you for thinking about contributing to the ActivityPub plugin! If you're unsure of anything, feel free to submit an issue or pull request on any topic. The worst that can happen is that you'll be politely directed to the best location to ask your question or to change something in your pull request. There are a variety of options for how you can help:
32+
Thank you for thinking about contributing to the ActivityPub plugin! We welcome contributions of all kinds, but to keep things productive for everyone, please follow these guidelines:
3333

34-
* Write and submit patches.
35-
* [Discuss new features and enhancements](https://github.com/Automattic/wordpress-activitypub/discussions).
36-
* If you found a bug, [file a report here](https://github.com/Automattic/wordpress-activitypub/issues/new?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen&template=bug_report.yml).
37-
* [Translate the ActivityPub plugin in your language](https://translate.wordpress.org/projects/wp-plugins/activitypub/).
34+
* **Keep issues clear and focused.** If you're reporting a bug, please use the [bug report form](https://github.com/Automattic/wordpress-activitypub/issues/new?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen&template=bug_report.yml). For feature ideas, please share them in [Discussions](https://github.com/Automattic/wordpress-activitypub/discussions) so we can consider them together.
35+
* **Stay relevant to the plugin's scope.** Issues and comments should relate directly to improving this plugin. Tangential ideas or unrelated feature requests will be closed.
36+
* **Be concise.** Short, actionable descriptions are much easier for maintainers to respond to.
37+
* **Respectful collaboration.** We follow the [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md). Please keep your contributions constructive and professional.
3838

39-
To clarify these expectations, we have adopted the code of conduct defined by the Contributor Covenant. [It can be read in full here](./CODE_OF_CONDUCT.md).
39+
Other ways to help include:
40+
41+
* Writing and submitting patches.
42+
* Translating the ActivityPub plugin into your language ([translate here](https://translate.wordpress.org/projects/wp-plugins/activitypub/)).
4043

4144
## Security
4245

0 commit comments

Comments
 (0)