Skip to content

Commit 25cd35e

Browse files
committed
Add heading labels
1 parent 3290b67 commit 25cd35e

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/contributing/first-time.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ Contributions to Plone are managed through git repositories on GitHub.
3333
This section first discusses what not to do, then how to work effectively with a project on GitHub.
3434

3535

36+
(things-not-to-do-label)=
37+
3638
### Things not to do
3739

3840
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.
6769
Duplicate pull requests may be ignored and closed without comment by the privileged GitHub teams.
6870
6971
72+
(plone-contributors-team-label)=
73+
7074
### Plone Contributors Team
7175
7276
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
8690
Please don't be "that person".
8791
8892
93+
(work-with-github-issues-label)=
94+
8995
### Work with GitHub issues
9096
9197
1. **Find issues that you want to work on.**
@@ -102,13 +108,17 @@ Please don't be "that person".
102108
Check for previous work in pull requests, assignment to another developer, or whether the requirements have changed.
103109
104110
111+
(set-up-your-environment-label)=
112+
105113
### Set up your environment
106114
107115
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.
108116
1. [Clone your forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository).
109117
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).
110118
111119
120+
(write-code-label)=
121+
112122
### Write code
113123
114124
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
136146
```
137147

138148

149+
(test-and-code-quality-label)=
150+
139151
### Test and code quality
140152

141153
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.
146158
A bug fix or new feature should have a test that ensures that it works as intended.
147159

148160

161+
(create-a-pull-request-from-your-fork-label)=
162+
149163
### Create a pull request from your fork
150164

151165
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

Comments
 (0)