Skip to content

Commit bb6e5fc

Browse files
committed
Tidy up agreement.md
1 parent 8c07954 commit bb6e5fc

File tree

1 file changed

+30
-37
lines changed

1 file changed

+30
-37
lines changed

coredev/agreement.md

Lines changed: 30 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
---
22
myst:
33
html_meta:
4-
"description": ""
5-
"property=og:description": ""
6-
"property=og:title": ""
7-
"keywords": ""
4+
"description": "Contributing to Plone"
5+
"property=og:description": "Contributing to Plone"
6+
"property=og:title": "Contributing to Plone"
7+
"keywords": "Contributing, Plone"
88
---
99

10-
# Contributing to Plone core
10+
(contributing-to-plone-label)=
11+
12+
# Contributing to Plone
1113

1214
There are many people and companies who rely on Plone on a day-to-day basis, so we must enforce some level of code quality control.
1315

@@ -17,55 +19,46 @@ Sending in a contributors agreement does not guarantee your commit access to the
1719

1820
We ask that before requesting core access you familiarize yourself a little with the community since they will help you get ramped up:
1921

20-
- Ask and (especially) answer questions on [the Plone forum](https://community.plone.org/) and in {doc}`Plone chat <culture>` with a focus on getting to know the active developers a bit.
22+
- Ask and (especially) answer questions on [the Plone forum](https://community.plone.org/) and in {doc}`Plone chat <culture>` with a focus on getting to know the active developers a bit.
2123

22-
- Attend a [conference](https://plone.org/events/conferences) / [symposium](http://plone.org/events/regional) or participate in a [sprint](https://plone.org/events/sprints).
24+
- Attend a [conference](https://plone.org/news-and-events/events/plone-conferences), [symposium](https://plone.org/news-and-events/events/regional), or participate in a [sprint](https://plone.org/news-and-events/events/sprints).
2325

24-
There are plenty of opportunities to meet the community and start contributing through various coding sessions,
25-
either in person or on the web.
26+
There are plenty of opportunities to meet the community and start contributing through various coding sessions, either in person or on the web.
2627

27-
You may even be able to get immediate core access at a conference if you are flexing your mad coding skills and the right people are attending.
28+
You may even be able to get immediate core access at a conference if you are flexing your mad coding skills and the right people are attending.
2829

29-
- Get your feet wet by contributing to the [collective](https://collective.github.io/).
30-
Don't worry about getting it perfect or asking for help;
31-
this way you get to know us and we improve our code together as a community.
30+
- Get your feet wet by contributing to the [collective](https://collective.github.io/).
31+
Don't worry about getting it perfect or asking for help.
32+
This way you get to know us and we improve our code together as a community.
3233

33-
- **Patches:** Historically we encouraged people to submit patches to the ticket collector.
34-
These tickets are usually ignored forever.
35-
Technically,
36-
in order for us to accept your patch you must sign the contributors agreement.
37-
If you want to contribute fixes,
38-
please just sign the agreement and go through the standard GitHub pull request process described below until you feel comfortable to bypass review.
39-
If the ticket is trivial,
40-
or you're fixing documentation,
41-
you do not need to sign a contributor's agreement.
34+
- **Patches:** Historically we encouraged people to submit patches to the ticket collector.
35+
These tickets are usually ignored forever.
36+
Technically, for us to accept your patch, you must sign the contributors agreement.
37+
If you want to contribute fixes, please just sign the agreement and go through the standard GitHub pull request process described below until you feel comfortable to bypass review.
38+
If the ticket is trivial, you do not need to sign a contributor's agreement.
4239

4340
Once you have familiarized yourself with the community and you are excited to contribute to the core:
4441

45-
- Sign the contributor agreement at <https://plone.org/foundation/contributors-agreement/agreement.pdf>,
46-
then either snail mail it to the address provided or scan and email it to <mailto:[email protected]>.
47-
This offers both copyright protection and ensures that the Plone Foundation is able to exercise some control over the codebase,
48-
ensuring it is not appropriated for someone's unethical purposes.
49-
For questions about why the agreement is required,
50-
please see {doc}`Contributor’s Agreement for Plone Explained <contributors_agreement_explained>`.
42+
- Sign the contributor agreement at <https://plone.org/foundation/contributors-agreement/agreement.pdf>, then either send by postal mail to the address provided, or scan and email it to <[email protected]>.
43+
This offers both copyright protection and ensures that the Plone Foundation is able to exercise some control over the codebase, ensuring it is not appropriated for someone's unethical purposes.
44+
For questions about why the agreement is required, please see [About the Plone Contributor Agreement
45+
](https://plone.org/foundation/contributors-agreement).
5146

52-
If you aren't sure where to start or just want more direction, feel free to get in the forum or in chat,
53-
and ask for help.
54-
While there is no official mentoring process, there are plenty of people willing to act in that role and
55-
guide you through the steps of getting involved in the community.
56-
A common way to start contributing is to participate in a [Plone sprint](ttps://plone.org/events/sprints).
47+
If you aren't sure where to start or just want more direction, feel free to get in the forum or in chat, and ask for help.
48+
While there is no official mentoring process, there are plenty of people willing to act in that role and guide you through the steps of getting involved in the community.
49+
A common way to start contributing is to participate in a [Plone sprint](https://plone.org/news-and-events/events/sprints).
5750

5851
**Welcome to the Plone community!**
5952

53+
6054
## Dealing with pull requests on GitHub
6155

6256
Before we can merge a pull request, we have to check that the author has signed the contributor's agreement.
6357

64-
If they're listed in <https://github.com/plone?tab=members>, the author has signed so we can go ahead and merge.
58+
If they're listed in <https://github.com/orgs/plone/teams/developers/members>, the author has signed so we can go ahead and merge.
6559

6660
If they aren't listed there, there's still a chance they have signed the contributor's agreement.
6761

68-
If they have signed before the move to GitHub, you can ask <mailto:[email protected]> to check.
62+
If they have signed before the move to GitHub, you can ask <[email protected]> to check.
6963

70-
Pull requests without contributor's agreement can only be merged in trivial cases,
71-
and only by the release manager.
64+
Pull requests without contributor's agreement can only be merged in trivial cases, and only by the release manager.

0 commit comments

Comments
 (0)