Skip to content

Commit 232b51e

Browse files
committed
Tidy up guidelines.md
1 parent 4d583b4 commit 232b51e

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

coredev/guidelines.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ myst:
77
"keywords": ""
88
---
99

10-
% -*- coding: utf-8 -*-
10+
```todo
11+
This should probably be purged.
12+
It is redundant to the default [CONTRUBITING.md](https://github.com/plone/.github/blob/main/CONTRIBUTING.md) and other files.
13+
```
1114

1215
% Note: this page is linked to from CONTRIBUTING.rst in all packages. Keep it short!
1316

@@ -20,37 +23,35 @@ Let's bring you up to speed with the minimum you need to know to start contribut
2023

2124
## Create an issue
2225

23-
- If you know the issue is for a specific package, you can add an issue there.
24-
When in doubt, create one in the [CMFPlone issue tracker](https://github.com/plone/Products.CMFPlone/issues).
26+
- If you know the issue is for a specific package, you can add an issue there.
27+
When in doubt, create one in the [CMFPlone issue tracker](https://github.com/plone/Products.CMFPlone/issues).
2528

26-
- Please specify a few things:
29+
- Please specify a few things:
2730

28-
- What steps reproduce the problem?
29-
- What do you expect when you do that?
30-
- What happens instead?
31-
- Which Plone version are you using?
31+
- What steps reproduce the problem?
32+
- What do you expect when you do that?
33+
- What happens instead?
34+
- Which Plone version are you using?
3235

33-
- If it is a visual issue, can you add a screen shot?
36+
- If it is a visual issue, can you add a screen shot?
37+
38+
- If there is an error in the Site Setup error log, please include it.
39+
Especially a traceback is helpful.
40+
Click on the 'Display traceback as text' link if you see it in the error log.
3441

35-
- If there is an error in the Site Setup error log, please include it.
36-
Especially a traceback is helpful.
37-
Click on the 'Display traceback as text' link if you see it in the error log.
3842

3943
## Create a pull request
4044

41-
- Legally,
42-
you can NOT contribute code unless you have signed the {doc}`contributor agreement <agreement>`.
43-
This means that we can NOT accept pull requests from you unless this is done,
44-
so please don't put the code reviewers at risk and do it anyways.
45-
- Add a changelog entry as file in the news directory.
46-
For helpful instructions, please see: <https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst>
47-
- For new features, an addition to README.rst is probably needed.
48-
A package may include other documentation that needs updating.
49-
- All text that can be shown in a browser must be translatable.
50-
Please mark all such strings as translatable.
51-
- Be nice and use code quality checkers like flake8 and jshint.
52-
- See if you can use git to squash multiple commits into one where this makes sense.
53-
If you are not comfortable with git, never mind.
54-
- If after reading this you become hesitant: don't worry.
55-
You can always create a pull request, mark it as WIP (work in progress),
56-
and improve the above points later.
45+
- Legally, you can NOT contribute code unless you have signed the {doc}`contributor agreement <agreement>`.
46+
This means that we can NOT accept pull requests from you unless this is done, so please don't put the code reviewers at risk and do it anyways.
47+
- Add a changelog entry as file in the news directory.
48+
For helpful instructions, please see: <https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst>
49+
- For new features, an addition to README.rst is probably needed.
50+
A package may include other documentation that needs updating.
51+
- All text that can be shown in a browser must be translatable.
52+
Please mark all such strings as translatable.
53+
- Be nice and use code quality checkers like flake8 and jshint.
54+
- See if you can use git to squash multiple commits into one where this makes sense.
55+
If you are not comfortable with git, never mind.
56+
- If after reading this you become hesitant: don't worry.
57+
You can always create a pull request, mark it as WIP (work in progress), and improve the above points later.

0 commit comments

Comments
 (0)