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
Copy file name to clipboardExpand all lines: docs/contributing/first-time.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,8 @@ Contributions to Plone are managed through git repositories on GitHub.
33
33
This section first discusses what not to do, then how to work effectively with a project on GitHub.
34
34
35
35
36
+
(things-not-to-do-label)=
37
+
36
38
### Things not to do
37
39
38
40
The following is a list of the most frequent mistakes made by first-time contributors.
@@ -67,6 +69,8 @@ Learn from their mistakes, and don't commit them yourself.
67
69
Duplicate pull requests may be ignored and closed without comment by the privileged GitHub teams.
68
70
69
71
72
+
(plone-contributors-team-label)=
73
+
70
74
### Plone Contributors Team
71
75
72
76
The Plone GitHub organization uses GitHub Teams to grant groups of GitHub users appropriate access to its repositories.
@@ -86,6 +90,8 @@ Core developers may ignore your contribution because you did not follow these in
86
90
Please don't be "that person".
87
91
88
92
93
+
(work-with-github-issues-label)=
94
+
89
95
### Work with GitHub issues
90
96
91
97
1. **Find issues that you want to work on.**
@@ -102,13 +108,17 @@ Please don't be "that person".
102
108
Check for previous work in pull requests, assignment to another developer, or whether the requirements have changed.
103
109
104
110
111
+
(set-up-your-environment-label)=
112
+
105
113
### Set up your environment
106
114
107
115
1. Start by [forking the project's repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) to your account through the GitHub interface.
108
116
1. [Clone your forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository).
109
117
1. [Configure git to sync your fork with the upstream repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#configuring-git-to-sync-your-fork-with-the-upstream-repository).
110
118
111
119
120
+
(write-code-label)=
121
+
112
122
### Write code
113
123
114
124
Once you have your environment set up, then you can follow standard best practices for working with git.
@@ -136,6 +146,8 @@ We ask for your patience as we work through complex automated workflows that nee
136
146
```
137
147
138
148
149
+
(test-and-code-quality-label)=
150
+
139
151
### Test and code quality
140
152
141
153
Follow the project's testing and code quality policies.
@@ -146,6 +158,8 @@ This will save you and reviewers a lot of time and frustration.
146
158
A bug fix or new feature should have a test that ensures that it works as intended.
147
159
148
160
161
+
(create-a-pull-request-from-your-fork-label)=
162
+
149
163
### Create a pull request from your fork
150
164
151
165
Once you have completed, tested, and linted your code, and created a {ref}`contributing-change-log-label`, then you can follow the standard practice for making a pull request.
0 commit comments