8000 chore: Update github issue and PR templates (#7767) · django-cms/django-cms@0f37d79 · GitHub
[go: up one dir, main page]
Skip to content

Commit 0f37d79

Browse files
fsbraunfsbraun
authored
chore: Update github issue and PR templates (#7767)
* Update github issue and PR templates * Update ---documentation-report.md
1 parent cd6df84 commit 0f37d79

File tree

5 files changed

+129
-132
lines changed

5 files changed

+129
-132
lines changed

‎.github/CONTRIBUTING.rst

Lines changed: 0 additions & 78 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/---bug-report.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
name: "\U0001F41E Bug report"
3+
about: Something isn't working as expected? Here is the right place to report.
4+
title: "[BUG]"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Please fill in each section below, otherwise, your issue will be closed.
12+
This info allows django CMS maintainers to diagnose (and fix!) your issue
13+
as quickly as possible.
14+
-->
15+
16+
## Description
17+
18+
<!--
19+
If this is a security issue stop immediately and follow the instructions at:
20+
http://docs.django-cms.org/en/latest/contributing/development-policies.html#reporting-security-issues
21+
-->
22+
23+
## Steps to reproduce
24+
25+
<!--
26+
Clear steps describing how to reproduce the issue.
27+
Steps to reproduce the behavior:
28+
1. Go to '...'
29+
2. Click on '....'
30+
3. Scroll down to '....'
31+
4. See error
32+
-->
33+
34+
## Expected behaviour
35+
36+
<!--
37+
A clear and concise description of what you expected to happen.
38+
-->
39+
40+
## Actual behaviour
41+
42+
<!--
43+
A clear and concise description of what is actually happening.
44+
-->
45+
46+
## Screenshots
47+
48+
<!--If applicable, add screenshots to help explain your problem.
49+
-->
50+
51+
## Additional information (CMS/Python/Django versions)
52+
53+
<!--
54+
Add any other context about the problem such as environment,
55+
CMS/Python/Django versions, logs etc. here.
56+
-->
57+
58+
## Do you want to help fix this issue?
59+
60+
<!--
61+
The django CMS project is managed and kept alive by its open source community and is backed by the [django CMS Association](https://www.django-cms.org/en/about-us/). We therefore welcome any help and are grateful if people contribute to the project. Please use 'x' to check the items below.
62+
-->
63+
64+
* [ ] Yes, I want to help fix this issue and I will join #workgroup-pr-review on [Slack](https://www.django-cms.org/slack) to confirm with the community that a PR is welcome.
65+
* [ ] No, I only want to report the issue.

‎.github/ISSUE_TEMPLATE/---documentation-report.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: "\U0001F4D8 Documentation report"
3+
about: "Something isn't described correctly in the documentation or needs to be updated?
4+
Here is the right place to report."
5+
title: "[DOC]"
6+
labels: 'component: documentation'
7+
assignees: ''
8+
9+
---
10+
11+
<!--
12+
Please fill in each section below, otherwise, your issue will be closed.
13+
This info allows django CMS maintainers to diagnose (and fix!) your issue
14+
as quickly as possible.
15+
-->
16+
17+
## Description
18+
19+
<!--
20+
If this is a security issue stop immediately and follow the instructions at:
21+
http://docs.django-cms.org/en/latest/contributing/development-policies.html#reporting-security-issues
22+
-->
23+
24+
## Screenshots
25+
26+
<!--If applicable, add screenshots to help explain your problem.
27+
-->
28+
29+
## Additional information (CMS/Python/Django versions)
30+
31+
<!--
32+
Add any other context about the problem such as environment,
33+
CMS/Python/Django versions, logs etc. here.
34+
-->
35+
36+
## Do you want to help fix this documentation issue?
37+
38+
<!--
39+
The django CMS project is managed and kept alive by its open source community and is backed by the [django CMS Association](https://www.django-cms.org/en/about-us/). We therefore welcome any help and are grateful if people contribute to the project. Please use 'x' to check the items below. 9E88
40+
-->
41+
42+
* [ ] Yes, I want to help fix this issue and I will join #workgroup-documentation on [Slack](https://www.django-cms.org/slack) to confirm with the team that a PR is welcome.
43+
* [ ] No, I only want to report the issue.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,30 @@
1-
<!--
2-
If this is a security-related patch stop immediately!
1+
## Description
32

4-
See http://docs.django-cms.org/en/latest/contributing/development-policies.html
3+
<!--
4+
If this is a security issue stop right here and follow our documentation:
5+
http://docs.django-cms.org/en/latest/contributing/development-policies.html#reporting-security-issues
56
-->
67

8+
## Related resources
79

8-
### Summary
9-
10-
Fixes #
11-
12-
13-
14-
### Links to related discussion
15-
10+
<!--
11+
Add here links to existing issues or conversation from GitHub
12+
or any other resource.
13+
-->
1614

15+
* #...
16+
* #...
1717

18-
### Proposed changes in this pull request
18+
## Checklist
1919

20+
<!--
21+
Please check the following items before submitting, otherwise,
22+
your pull request will be closed.
2023
21-
### Documentation checklist
24+
Use 'x' to check each item: [x] I have ...
25+
-->
2226

23-
* [ ] I have updated CHANGELOG.txt if appropriate
24-
* [ ] I have updated the release notes document if appropriate, with:
25-
* [ ] general notes
26-
* [ ] bug-fixes
27-
* [ ] improvements/new features
28-
* [ ] backwards-incompatible changes
29-
* [ ] required upgrade steps
30-
* [ ] names of contributors
31-
* [ ] I have updated other documentation
32-
* [ ] I have added my name to the AUTHORS file
33-
* [ ] This PR's documentation has been approved by Daniele Procida
27+
* [ ] I have opened this pull request against ``develop-4``
28+
* [ ] I have added or modified the tests when changing logic
29+
* [ ] I have followed [the conventional commits guidelines](https://www.conventionalcommits.org/) to add meaningful information into the changelog
30+
* [ ] I have read the [contribution guidelines ](https://github.com/django-cms/django-cms/blob/develop/CONTRIBUTING.rst) and I have joined #workgroup-pr-review on [Slack](https://www.django-cms.org/slack) to find a “pr review buddy” who is going to review my pull request.

0 commit comments

Comments
 (0)
0