You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
First discuss whether you should perform any work.
72
-
Any method below is acceptable, but are listed in order of most likely to get a response.
71
+
In the Plone organization, it is strongly recommended that you read {ref}`contributing-permission-to-publish-label` and take appropriate action.
73
72
74
-
- Search for open issues in [`documentation`](https://github.com/plone/documentation/issues), [`plone.api`](https://github.com/plone/plone.api/issues), [`plone.restapi`](https://github.com/plone/plone.restapi/issues), or [`volto`](https://github.com/plone/volto/issues) and comment on them.
75
-
- Create a new issue in [`documentation`](https://github.com/plone/documentation/issues), [`plone.api`](https://github.com/plone/plone.api/issues), [`plone.restapi`](https://github.com/plone/plone.restapi/issues), or [`volto`](https://github.com/plone/volto/issues).
76
-
- Discuss during conferences, trainings, and other Plone events.
77
-
- Ask on the [Plone Community Forum, Documentation topic](https://community.plone.org/c/documentation/13).
78
-
- Ask in the [Plone chat on Discord](https://discord.com/invite/zFY3EBbjaj).
73
+
After your Plone Contributor Agreement has been approved, and you have been added to the Plone GitHub organization as a member of the [Developers](https://github.com/orgs/plone/teams/developers) team, we recommend that you follow our guidelines.
79
74
80
-
As a convenience, at the top right of every page, there is a GitHub navigation menu.
81
-
Tap, click, or hover over the GitHub Octocat icon for options.
75
+
1. Discuss whether you should perform any work.
76
+
Any method below is acceptable, but are listed in order of most likely to get a response.
82
77
83
-
```{image} /_static/github-navigation.png
84
-
:alt: GitHub navigation menu
85
-
```
78
+
- Search for open issues in the issue trackers of documented projects, and comment on them.
79
+
If an issue does not already exist for what you want to work on, then create a new issue in its issue tracker.
80
+
81
+
As a convenience, at the top right of every page, there is a GitHub navigation menu.
82
+
Tap, click, or hover over the GitHub Octocat icon for options.
83
+
84
+
```{image} /_static/github-navigation.png
85
+
:alt: GitHub navigation menu
86
+
```
87
+
88
+
You can use this menu to quickly navigate to the `documentation` source repository or open an issue.
89
+
Note that this navigation convenience is provided only for the `documentation` repository.
- Discuss during sprints, conferences, trainings, and other Plone events.
97
+
- Ask on the [Plone Community Forum, Documentation topic](https://community.plone.org/c/documentation/13).
98
+
- Ask in the [Plone chat on Discord](https://discord.com/invite/zFY3EBbjaj).
99
+
100
+
1. For first-time contributors especially, **you do not need to ask to be assigned to, or to work on, an open issue**.
101
+
As in any open source project, you can start work on open issues at your convenience.
102
+
103
+
```{tip}
104
+
Working on documentation or on issues labeled with either `33 needs: docs` or `41 lvl: easy` are the two best ways for first-timers to contribute.
105
+
This is because first-timers have a fresh perspective that might be overlooked by old-timers.
106
+
```
107
+
108
+
1. Clarify the scope of work that needs to be done.
109
+
Check for previous work, assignment to another developer, or whether the requirements have changed.
110
+
1. [Assign yourself to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users).
111
+
This signals to other developers that you are working on the issue.
86
112
87
-
You can use this menu to quickly navigate to the `documentation` source repository or open an issue.
88
-
Note that this navigation convenience is provided only for the `documentation` repository.
113
+
From here, you can either make {ref}`contributing-quick-edits-label` or {ref}`contributing-large-edits-label`.
89
114
90
115
91
116
(contributing-quick-edits-label)=
@@ -101,9 +126,10 @@ Quick edits for minor issues, such as typographical errors, misspellings, and En
101
126
```{image} /_static/edit-pencil-icon.png
102
127
:alt: GitHub Edit this file
103
128
```
104
-
1. Make edits, add a commit message, select {guilabel}`Create a **new branch** for this commit and start a pull request`, then click {guilabel}`Propose changes`.
129
+
1. Make edits, add a commit message, select {guilabel}`Create a new branch for this commit and start a pull request`, then click {guilabel}`Propose changes`.
105
130
1. Make your pull request against the branch `6-dev`.
106
131
1. Members who subscribe to the repository will receive a notification and review your request.
132
+
1. Request a review from other team members.
107
133
108
134
109
135
(contributing-large-edits-label)=
@@ -171,6 +197,7 @@ This section describes how to make contributions to files in the `plone/document
171
197
172
198
1. Visit the GitHub `documentation` repository, and [create a pull request](https://github.com/plone/documentation/compare) against the branch `6-dev`.
173
199
1. Members who subscribe to the repository will receive a notification and review your request.
0 commit comments