Skip to content

Commit 0249f54

Browse files
BHUVANSH855BHUVANSH855
committed
DOCUMENTATION
1 parent fa73d31 commit 0249f54

6 files changed

Lines changed: 231 additions & 41 deletions

File tree

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Code of Conduct
2+
3+
## Our Commitment
4+
5+
The Punjabi (`pa`) Python Documentation Translation Project is committed to providing a welcoming, respectful, and collaborative environment for everyone. We value constructive communication, mutual respect, and inclusive participation regardless of experience level, background, or identity.
6+
7+
Our goal is to work together to produce accurate, consistent, and high-quality Punjabi translations of the official Python documentation.
8+
9+
---
10+
11+
# Expected Behavior
12+
13+
All contributors are expected to:
14+
15+
- Be respectful and professional in all interactions.
16+
- Provide constructive and respectful feedback.
17+
- Welcome new contributors and help them learn the project workflow.
18+
- Follow the project's `CONTRIBUTING.md`, `STYLE_GUIDE.md`, and `GLOSSARY.md`.
19+
- Respect reviewer decisions and participate in discussions collaboratively.
20+
- Focus discussions on improving translation quality and project consistency.
21+
22+
---
23+
24+
# Unacceptable Behavior
25+
26+
Examples of unacceptable behavior include:
27+
28+
- Harassment, discrimination, or personal attacks.
29+
- Offensive or abusive language.
30+
- Trolling, intimidation, or deliberately disruptive behavior.
31+
- Knowingly submitting misleading, malicious, or low-quality contributions.
32+
- Public or private harassment of contributors or reviewers.
33+
34+
---
35+
36+
# Translation Discussions
37+
38+
Translation decisions should be based on:
39+
40+
- Technical accuracy
41+
- Consistency with the project glossary
42+
- Compliance with the project style guide
43+
- Natural and clear Punjabi
44+
- Constructive discussion and consensus
45+
46+
Disagreements are a normal part of collaborative translation and should always be handled respectfully.
47+
48+
---
49+
50+
# Reporting Issues
51+
52+
If you experience or observe behavior that violates this Code of Conduct, please open a private discussion with one of the project coordinators or create an issue if appropriate.
53+
54+
Project Coordinators:
55+
56+
- [@BHUVANSH855](https://github.com/BHUVANSH855)
57+
- [@mohityadav8](https://github.com/mohityadav8)
58+
- [@jangrayash1505](https://github.com/jangrayash1505)
59+
60+
---
61+
62+
# Enforcement
63+
64+
Project coordinators are responsible for maintaining a welcoming and productive community. They may remove inappropriate content, request changes to contributions, or take other appropriate actions when this Code of Conduct is violated.
65+
66+
---
67+
68+
# Scope
69+
70+
This Code of Conduct applies to all project spaces, including:
71+
72+
- GitHub Issues
73+
- Pull Requests
74+
- Discussions
75+
- Code Reviews
76+
- Repository documentation
77+
- Translation and review activities
78+
79+
---
80+
81+
# Acknowledgements
82+
83+
This Code of Conduct is inspired by established open source community practices and has been adapted for the Punjabi Python Documentation Translation Project.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 69 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,106 @@
11
---
22
name: Bug Report
3-
about: Report a bug or validation issue in the Punjabi translation project.
3+
about: Report a bug, translation issue, validation error, or documentation problem in the Punjabi translation project.
44
title: "[BUG] "
55
labels: bug
66
assignees: ""
77
---
88

99
# Bug Report
1010

11-
## Description
11+
Thank you for helping improve the Punjabi (`pa`) translation of the Python documentation.
1212

13-
Provide a clear and concise description of the problem.
13+
Please provide as much information as possible to help us reproduce and resolve the issue.
1414

1515
---
1616

17-
## Affected File(s)
17+
# Bug Summary
1818

19-
Example:
19+
Provide a clear and concise description of the issue.
2020

21-
- `tutorial/classes.po`
22-
- `library/stdtypes.po`
21+
-
2322

2423
---
2524

26-
## Steps to Reproduce
25+
# Category
26+
27+
Select all that apply.
28+
29+
- [ ] Translation error
30+
- [ ] Terminology inconsistency
31+
- [ ] Formatting / reStructuredText markup
32+
- [ ] Broken cross-reference
33+
- [ ] Validation failure
34+
- [ ] GitHub Actions
35+
- [ ] Documentation issue
36+
- [ ] Repository tooling
37+
- [ ] Other
38+
39+
---
40+
41+
# Affected Documentation Area
42+
43+
Examples:
44+
45+
- Tutorial
46+
- Using Python
47+
- Standard Library
48+
- HOWTO
49+
- FAQ
50+
- Reference
51+
- C API
52+
- What's New
53+
- Repository documentation
54+
55+
Documentation area:
56+
57+
-
58+
59+
Affected file(s):
60+
61+
- `example.po`
62+
63+
---
64+
65+
# Steps to Reproduce
2766

2867
1.
2968
2.
3069
3.
3170

3271
---
3372

34-
## Expected Behavior
73+
# Expected Behavior
3574

3675
Describe what you expected to happen.
3776

77+
-
78+
3879
---
3980

40-
## Actual Behavior
81+
# Actual Behavior
4182

4283
Describe what actually happened.
4384

85+
-
86+
4487
---
4588

46-
## Validation Output
89+
# Validation Output (if applicable)
4790

48-
If applicable, paste the output from:
91+
Include any relevant validation output.
4992

5093
```text
5194
msgfmt
5295
sphinx-lint
5396
HTML build
97+
Nitpicky build
5498
GitHub Actions
5599
```
56100

57101
---
58102

59-
## Environment
103+
# Environment
60104

61105
- Operating System:
62106
- Python Version:
@@ -65,6 +109,16 @@ GitHub Actions
65109

66110
---
67111

68-
## Additional Information
112+
# Additional Information
113+
114+
Include anything that may help reproduce or understand the issue.
115+
116+
Examples:
117+
118+
- screenshots
119+
- logs
120+
- source English text
121+
- suggested translation
122+
- related issue or discussion
69123

70-
Add any other relevant information, screenshots, or logs.
124+
-

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@ blank_issues_enabled: true
33
contact_links:
44
- name: Python Documentation Translation Project
55
url: https://devguide.python.org/documentation/translations/
6-
about: Learn about the official Python Documentation Translation project.
6+
about: Learn about the official Python Documentation Translation project and its workflow.
77

88
- name: Python Documentation Translation on Transifex
99
url: https://explore.transifex.com/python-doc/python-newest/
10-
about: View the official Python Documentation translation platform.
10+
about: Access the official Python Documentation translation platform.
1111

1212
- name: Project Documentation
13-
url: https://github.com/BHUVANSH855/python-docs-pa
14-
about: Read the project's documentation before opening an issue.
13+
url: https://github.com/BHUVANSH855/python-docs-pa#readme
14+
about: Read the README, contribution guidelines, style guide, and glossary before opening an issue.
15+
16+
- name: Contribution Guidelines
17+
url: https://github.com/BHUVANSH855/python-docs-pa/blob/3.15/CONTRIBUTING.md
18+
about: Learn how to contribute translations, reviews, and repository improvements.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 59 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,38 +8,87 @@ assignees: ""
88

99
# Feature Request
1010

11-
## Summary
11+
Thank you for helping improve the Punjabi (`pa`) translation of the Python documentation.
1212

13-
Provide a clear description of your proposed feature or improvement.
13+
Please describe your idea using the sections below.
1414

1515
---
1616

17-
## Motivation
17+
# Feature Summary
18+
19+
Provide a clear and concise description of the proposed improvement.
20+
21+
-
22+
23+
---
24+
25+
# Category
26+
27+
Select all that apply.
28+
29+
- [ ] Translation improvement
30+
- [ ] Documentation improvement
31+
- [ ] Glossary enhancement
32+
- [ ] Style Guide improvement
33+
- [ ] Contributor experience
34+
- [ ] Validation workflow
35+
- [ ] GitHub Actions / CI
36+
- [ ] Repository tooling
37+
- [ ] Automation
38+
- [ ] Other
39+
40+
---
41+
42+
# Motivation
1843

1944
Why would this improvement benefit the project?
2045

46+
Examples:
47+
48+
- improve translation quality
49+
- improve consistency
50+
- simplify contributor workflow
51+
- improve validation
52+
- reduce maintenance effort
53+
54+
-
55+
2156
---
2257

23-
## Proposed Solution
58+
# Proposed Solution
2459

2560
Describe your proposed solution.
2661

62+
-
63+
2764
---
2865

29-
## Alternatives Considered
66+
# Alternatives Considered
3067

3168
Describe any alternative approaches you considered.
3269

70+
-
71+
3372
---
3473

35-
## Additional Context
74+
# Additional Context
75+
76+
Include any useful information such as:
77+
78+
- examples
79+
- screenshots
80+
- references
81+
- related discussions
82+
- related issues
83+
- relevant Python documentation
3684

37-
Include links, screenshots, references, or examples if applicable.
85+
-
3886

3987
---
4088

41-
## Checklist
89+
# Contributor Checklist
4290

43-
- [ ] This feature aligns with the goals of the project.
44-
- [ ] I have checked for similar existing requests.
91+
- [ ] This proposal aligns with the goals of the project.
92+
- [ ] I searched for similar feature requests before creating this issue.
93+
- [ ] I have provided enough information for discussion.
4594
- [ ] I am willing to help implement this feature (optional).

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ The Punjabi (`pa`) translation project is maintained collaboratively by a team o
4040

4141
The project is currently coordinated by:
4242

43-
- Bhuvansh Kataria (@BHUVANSH855)
44-
- Mohit Yadav (@mohityadav8)
45-
- Yashraj Jangra (@jangrayash1505)
43+
- Bhuvansh Kataria [@BHUVANSH855](https://github.com/BHUVANSH855)
44+
- Mohit Yadav [@mohityadav8](https://github.com/mohityadav8)
45+
- Yashraj Jangra [@Yashraj-Jangra](https://github.com/Yashraj-Jangra)
4646

4747
The coordinators are responsible for:
4848

0 commit comments

Comments
 (0)