Skip to content

Commit 89979e3

Browse files
committed
docs: add GitHub community health files
1 parent 56c3fb2 commit 89979e3

5 files changed

Lines changed: 206 additions & 0 deletions

File tree

‎.github/CODE_OF_CONDUCT.md‎

Whitespace-only changes.
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or validation issue in the Punjabi translation project.
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
# Bug Report
10+
11+
## Description
12+
13+
Provide a clear and concise description of the problem.
14+
15+
---
16+
17+
## Affected File(s)
18+
19+
Example:
20+
21+
- `tutorial/classes.po`
22+
- `library/stdtypes.po`
23+
24+
---
25+
26+
## Steps to Reproduce
27+
28+
1.
29+
2.
30+
3.
31+
32+
---
33+
34+
## Expected Behavior
35+
36+
Describe what you expected to happen.
37+
38+
---
39+
40+
## Actual Behavior
41+
42+
Describe what actually happened.
43+
44+
---
45+
46+
## Validation Output
47+
48+
If applicable, paste the output from:
49+
50+
```text
51+
msgfmt
52+
sphinx-lint
53+
HTML build
54+
GitHub Actions
55+
```
56+
57+
---
58+
59+
## Environment
60+
61+
- Operating System:
62+
- Python Version:
63+
- Sphinx Version:
64+
- gettext Version:
65+
66+
---
67+
68+
## Additional Information
69+
70+
Add any other relevant information, screenshots, or logs.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: true
2+
3+
contact_links:
4+
- name: Python Documentation Translation Project
5+
url: https://devguide.python.org/documentation/translations/
6+
about: Learn about the official Python Documentation Translation project.
7+
8+
- name: Python Documentation Translation on Transifex
9+
url: https://explore.transifex.com/python-doc/python-newest/
10+
about: View the official Python Documentation translation platform.
11+
12+
- name: Project Documentation
13+
url: https://github.com/BHUVANSH855/python-docs-pa
14+
about: Read the project's documentation before opening an issue.
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an improvement for the Punjabi translation project.
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
# Feature Request
10+
11+
## Summary
12+
13+
Provide a clear description of your proposed feature or improvement.
14+
15+
---
16+
17+
## Motivation
18+
19+
Why would this improvement benefit the project?
20+
21+
---
22+
23+
## Proposed Solution
24+
25+
Describe your proposed solution.
26+
27+
---
28+
29+
## Alternatives Considered
30+
31+
Describe any alternative approaches you considered.
32+
33+
---
34+
35+
## Additional Context
36+
37+
Include links, screenshots, references, or examples if applicable.
38+
39+
---
40+
41+
## Checklist
42+
43+
- [ ] This feature aligns with the goals of the project.
44+
- [ ] I have checked for similar existing requests.
45+
- [ ] I am willing to help implement this feature (optional).

‎.github/pull_request_template.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Pull Request
2+
3+
## Summary
4+
5+
Provide a brief summary of your changes.
6+
7+
---
8+
9+
## Type of Change
10+
11+
Please check all that apply.
12+
13+
- [ ] New translation
14+
- [ ] Translation improvement
15+
- [ ] Documentation update
16+
- [ ] Contributor documentation
17+
- [ ] Validation workflow
18+
- [ ] GitHub Actions
19+
- [ ] Repository maintenance
20+
- [ ] Bug fix
21+
- [ ] Other
22+
23+
---
24+
25+
## Files Changed
26+
27+
List the files modified in this pull request.
28+
29+
-
30+
31+
---
32+
33+
## Translation Details (if applicable)
34+
35+
Documentation area:
36+
37+
-
38+
39+
Language:
40+
41+
- Punjabi (`pa`)
42+
43+
Approximate number of translated strings:
44+
45+
-
46+
47+
---
48+
49+
## Validation
50+
51+
Confirm that the following checks have been completed before submitting this pull request.
52+
53+
- [ ] `msgfmt --check`
54+
- [ ] `sphinx-lint`
55+
- [ ] HTML documentation build completed successfully
56+
- [ ] Nitpicky (`-n`) build completed successfully (if applicable)
57+
- [ ] No untranslated or fuzzy messages introduced
58+
- [ ] Terminology follows `GLOSSARY.md`
59+
- [ ] Translation follows `STYLE_GUIDE.md`
60+
61+
---
62+
63+
## Additional Notes
64+
65+
Include any additional information reviewers should know.
66+
67+
-
68+
69+
---
70+
71+
## Checklist
72+
73+
- [ ] I have read the project's `CONTRIBUTING.md`.
74+
- [ ] My changes follow the project's Style Guide.
75+
- [ ] I have validated my changes locally.
76+
- [ ] I have updated documentation where necessary.
77+
- [ ] This pull request is ready for review.

0 commit comments

Comments
 (0)