Skip to content

Commit 5771fc4

Browse files
committed
Enhance Work with GitHub issues
- Refer to Avoid duplicate effort - Improve wording
1 parent 6db5127 commit 5771fc4

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/contributing/first-time.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,14 +87,19 @@ Please don't be "that person".
8787
Working on documentation or on issues labeled with either `33 needs: docs` or `41 lvl: easy` are the two best ways for first-time contributors to contribute.
8888
This is because first-timers have a fresh perspective that might be overlooked by old-timers.
8989
1. **Discuss whether you should perform any work.**
90-
Any method below is acceptable, but are listed in order of most likely to get a response.
90+
First see {ref}`Avoid duplicate effort <mistake-2-label>`.
91+
Next, any discussion method listed below is acceptable, and they are listed in the order of most likely to get a response.
9192
- Search for open issues in the issue trackers of Plone projects on GitHub, and comment on them.
9293
- If an issue does not already exist for what you want to work on, then create a new issue in its issue tracker.
94+
Use a descriptive title and description, include steps to reproduce the issue, and screenshots or videos that demonstrate the issue.
9395
- Discuss during sprints, conferences, trainings, and other Plone events.
94-
- Ask on the [Plone Community Forum](https://community.plone.org/).
95-
- Ask in the [Plone chat on Discord](https://discord.com/invite/zFY3EBbjaj).
96+
- Discuss on the [Plone Community Forum](https://community.plone.org/).
97+
- Discuss in the [Plone chat on Discord](https://discord.com/invite/zFY3EBbjaj).
9698
1. **Clarify the scope of work that needs to be done.**
97-
Check for previous work in pull requests, assignment to another developer, or whether the requirements have changed.
99+
Sometimes the issue description is blank or lacks clarity, the requirements have changed since it was created, or work has been completed in a pull request but the issue was not closed.
100+
Ask for clarification, whether it is still relevant, or whether it should be closed.
101+
102+
After you have satisfied the above steps and have clear direction on how to proceed, then you can begin work on the issue.
98103

99104

100105
(set-up-your-environment-label)=

0 commit comments

Comments
 (0)