Skip to content

Commit 1d69e14

Browse files
authored
Tweak first-time contributors (#1818)
- Move the section about free support to the top of the page, outside "For students and learners", and make it less curmudgeonly - Rephrase grumpy text to be nicer, giving guidance to first-timers - Remove redundant "free support" sentence. - Convert a `first-contributions` resource to a "see also" for better visibility - Attempt to drive home that first-timers should do the Plone CLA first - Define "unclaimed" issue. - Clarify how to claim an issue. - Give guidance to determine whether an issue has been claimed, if it is not clear - Correct the process to include acceptance of the invitation to join a Plone Team in GitHub
1 parent 5dd3254 commit 1d69e14

File tree

1 file changed

+23
-18
lines changed

1 file changed

+23
-18
lines changed

docs/contributing/first-time.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,22 @@ myst:
1313

1414
This chapter provides guidance to first-time contributors to Plone and all its projects and repositories under the Plone GitHub organization.
1515

16+
```{important}
17+
For free support, training, guidance, or mentoring, you should work through some [trainings](https://training.plone.org/), ask questions in the [Plone Community Forum](https://community.plone.org/), participate in an [event](https://plone.org/news-and-events/events), and **do not use GitHub**.
18+
Members of the Plone organization may delete comments, lock conversations, or block GitHub users who ignore this.
19+
```
20+
1621

1722
(for-students-and-learners)=
1823

1924
## For students and learners
2025

21-
```{important}
22-
**We do not offer training, guidance, or mentoring to students or learners on GitHub.**
23-
Don't ask for it.
24-
The Plone organization may delete comments, lock conversations, or block GitHub users who ignore this.
25-
```
26-
27-
If you are a student or learner of Plone, you probably are not a contributor.
28-
See the next section, {ref}`expectations-of-first-time-contributors`, to determine whether you are in fact a contributor.
26+
If you are a student or learner of Plone, you might not be a contributor yet, but you can work toward that.
27+
See the next section, {ref}`expectations-of-first-time-contributors`, to determine what it takes to become a contributor.
2928

29+
```{seealso}
3030
To learn how to use git and GitHub and make your first contribution to open source software, visit the amazing resource [`first-contributions`](https://github.com/firstcontributions/first-contributions).
31-
32-
For free support, training, guidance, or mentoring, you should work through some trainings, use the [Plone Community Forum](https://community.plone.org/), participate in an [event](https://plone.org/news-and-events/events), and **not use GitHub**.
31+
```
3332

3433

3534
(expectations-of-first-time-contributors)=
@@ -68,6 +67,8 @@ Such motivation behind these contributions usually results in poor quality break
6867
## Requirements
6968

7069
All first-time contributors to Plone must follow the contributing requirements described in {doc}`index`.
70+
**Do this step now.**
71+
If you skip this step, then your contribution can't be accepted.
7172

7273
For [Plone Google Summer of Code (GSoC)](https://plone.org/community/gsoc) applicants, you must also follow both our and its program guidelines.
7374

@@ -79,6 +80,10 @@ For [Plone Google Summer of Code (GSoC)](https://plone.org/community/gsoc) appli
7980
Contributions to Plone are managed through git repositories on GitHub.
8081
This section first discusses what not to do, then how to work effectively with a project on GitHub.
8182

83+
```{danger}
84+
Only people who have completed the {ref}`first-time-requirements-label` described above should make contributions.
85+
```
86+
8287

8388
(things-not-to-do-label)=
8489

@@ -90,17 +95,17 @@ Learn from their mistakes, and don't commit them yourself.
9095
(mistake-1-label)=
9196

9297
1. **Never ask to be assigned to an issue.**
93-
Instead you may post a comment to claim it, if no one else has claimed it (see {ref}`Avoid duplicate effort <mistake-2-label>`).
94-
For example, "I am working on this issue in pull request #123."
95-
You do not need to ask to be assigned to, or to work on, an open issue.
96-
As in any open source software project, you can start work on open issues at your convenience.
97-
Privileged team members may ignore or delete comments asking to be assigned to an issue.
98+
If an issue is unclaimed—either by assignment, an open pull request, or an explicit comment such as "I am working on this issue"—then it is available to work on by **any member of a Plone Team in GitHub**.
99+
As a member of a Plone Team, you may post a comment in any unclaimed issue to claim it.
100+
See {ref}`Avoid duplicate effort <mistake-2-label>`.
101+
Privileged Plone Team members may ignore or delete comments asking to be assigned to an issue.
98102

99103
(mistake-2-label)=
100104

101105
2. **Avoid duplicate effort.**
102106
Don't work on issues that have already been claimed or worked on, unless such effort has been abandoned by the author.
103-
GitHub's interface provides links to related issues and pull requests, and who is assigned to an issue.
107+
Use GitHub's interface to view related issues, pull requests, and who is assigned to an issue.
108+
If it is not clear whether an issue has been claimed or abandoned, you may ask by posting a comment such as, "Is anyone working on this issue?"
104109
Pull requests will be reviewed in the order received.
105110
Duplicate pull requests may be ignored and closed without comment by the privileged GitHub teams.
106111

@@ -129,8 +134,8 @@ Learn from their mistakes, and don't commit them yourself.
129134
### Plone Contributors Team
130135

131136
The Plone GitHub organization uses GitHub Teams to grant groups of GitHub users appropriate access to its repositories.
132-
New users, including GSoC applicants, are assigned to the [Contributors](https://github.com/orgs/plone/teams/contributors) Team within a few business days after they have signed and returned the {ref}`Plone Contributor Agreement <contributing-sign-and-return-the-plone-contributor-agreement-label>`.
133-
New contributors should wait for confirmation that they have been added to this team before creating a pull request to a Plone project.
137+
First-time contributors, including GSoC applicants, are assigned to the [Contributors](https://github.com/orgs/plone/teams/contributors) Team within a few business days after they have signed and returned the {ref}`Plone Contributor Agreement <contributing-sign-and-return-the-plone-contributor-agreement-label>`.
138+
New contributors should wait for an invitation to join this team, and accept it, before creating a pull request to a Plone project.
134139

135140

136141
(first-time-mr-roboto-on-github-label)=

0 commit comments

Comments
 (0)