Skip to content

Commit 918a06b

Browse files
committed
Update first-time contributors per Volto Team discussion
1 parent c83e3f9 commit 918a06b

File tree

1 file changed

+43
-8
lines changed

1 file changed

+43
-8
lines changed

docs/contributing/first-time.md

Lines changed: 43 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,29 @@ 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-
It is assumed that the first-time contributor has already {doc}`installed Plone <../install/index>` on their development machine, has a GitHub account, and has basic knowledge of using git and GitHub.
16+
As a first-time contributor to Plone, we expect that you have:
17+
18+
- {ref}`tried a Plone demo <install-index-getting-started-label>`
19+
- {doc}`installed Plone <../install/index>` on your development machine
20+
- worked through some trainings, such as the recommended:
21+
- {doc}`training:mastering-plone/index`
22+
- {doc}`training:voltohandson/index`
23+
- {doc}`training:voltoaddons/index`
24+
- {doc}`training:volto_customization/index`
25+
- {doc}`training:plone-deployment/index`
26+
- read the chapters of {doc}`/index` relevant to your contribution
27+
- a sincere interest to contribute to Plone and become an ongoing contributing member of our organization
28+
- a GitHub account
29+
- basic knowledge of using git and GitHub
30+
31+
```{warning}
32+
As a first-time contributor, you are warned that Plone might not be a good match for you.
33+
34+
- Plone is a relatively complex web application.
35+
It takes a significant amount of time to learn how to develop Plone.
36+
- Members of the Plone GitHub organization volunteer their free time to develop Plone, and offer limited mentoring only through the Google Summer of Code program.
37+
- If you want free support, training, or mentoring, you should use the [Plone Community Forum](https://community.plone.org/) and not use GitHub.
38+
```
1739

1840

1941
(first-time-requirements-label)=
@@ -63,7 +85,7 @@ Learn from their mistakes, and don't commit them yourself.
6385
### Plone Contributors Team
6486

6587
The Plone GitHub organization uses GitHub Teams to grant groups of GitHub users appropriate access to its repositories.
66-
New users, including GSoC applicants, are assigned to the [Contributors](https://github.com/orgs/plone/teams/contributors) Team within a few days after they have signed and returned the {ref}`Plone Contributor Agreement <contributing-sign-and-return-the-plone-contributor-agreement-label>`.
88+
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>`.
6789
New contributors should wait for confirmation that they have been added to this team before creating a pull request to a Plone project.
6890

6991

@@ -147,7 +169,9 @@ We ask for your patience as we work through complex automated workflows that nee
147169
Follow the project's testing and code quality policies.
148170
Most projects have a test suite and code quality checkers and formatters.
149171
We strongly recommend that you run the project's test suite and code quality checks locally before proceeding.
150-
This will save you and reviewers a lot of time and frustration.
172+
Do not depend upon our continuous integration and GitHub Workflows to run these checks for you.
173+
Every commit you push sends an email notification to repository subscribers.
174+
This will save you, members, and reviewers a lot of time and frustration.
151175

152176
A bug fix or new feature should have a test that ensures that it works as intended.
153177

@@ -168,15 +192,26 @@ Once you have completed, tested, and linted your code, and created a {ref}`contr
168192

169193
1. Visit your fork of the Plone repository on GitHub, and [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) against the development branch.
170194
- Make your title and description descriptive.
171-
Don't be lazy with "Fixes bug" or other useless drivel.
172-
- To automatically close the original issue when your pull request is merged, include "Closes #issue_number" in your description.
195+
- Include "Fixes #" and the related issue number.
196+
This enables automatic closing of the related issue when the pull request is merged.
173197
This also creates a hyperlink to the original issue for easy reference.
198+
- Don't be lazy with "Fixes bug" or other useless drivel.
174199
1. [Request a review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review) from other team members.
175200
1. Members who subscribe to the repository will receive a notification and review your request.
176201
177-
```{todo}
178-
Provide instructions when the contributor needs to update their pull request with changes from the default branch.
179-
Members of Contributors do not have the button "Update branch" to easily do this, and must use git foo to manage the situation.
202+
203+
### Update your pull request from your fork
204+
205+
Often another pull request will get merged before yours, and your pull request will fall behind the main branch.
206+
To keep your pull request current, you can issue the follow git commands.
207+
208+
```shell
209+
# Assume `main` is the main branch.
210+
git checkout main
211+
git pull
212+
git checkout my_branch_name
213+
git merge main
214+
git push
180215
```
181216
182217
Welcome to the Plone community, and thank you for contributing!

0 commit comments

Comments
 (0)