Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 2 additions & 80 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,83 +1,5 @@
# Code of Conduct

## Our Commitment
This project follows the [Python Software Foundation Code of Conduct](https://policies.python.org/python.org/code-of-conduct/). We expect everyone who takes part in this repository, in Transifex and in related discussions to follow it.

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.

Our goal is to work together to produce accurate, consistent, and high-quality Punjabi translations of the official Python documentation.

---

# Expected Behavior

All contributors are expected to:

- Be respectful and professional in all interactions.
- Provide constructive and respectful feedback.
- Welcome new contributors and help them learn the project workflow.
- Follow the project's `CONTRIBUTING.md`, `STYLE_GUIDE.md`, and `GLOSSARY.md`.
- Respect reviewer decisions and participate in discussions collaboratively.
- Focus discussions on improving translation quality and project consistency.

---

# Unacceptable Behavior

Examples of unacceptable behavior include:

- Harassment, discrimination, or personal attacks.
- Offensive or abusive language.
- Trolling, intimidation, or deliberately disruptive behavior.
- Knowingly submitting misleading, malicious, or low-quality contributions.
- Public or private harassment of contributors or reviewers.

---

# Translation Discussions

Translation decisions should be based on:

- Technical accuracy
- Consistency with the project glossary
- Compliance with the project style guide
- Natural and clear Punjabi
- Constructive discussion and consensus

Disagreements are a normal part of collaborative translation and should always be handled respectfully.

---

# Reporting Issues

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.

Project Coordinators:

- [@BHUVANSH855](https://github.com/BHUVANSH855)
- [@mohityadav8](https://github.com/mohityadav8)
- [@jangrayash1505](https://github.com/jangrayash1505)

---

# Enforcement

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.

---

# Scope

This Code of Conduct applies to all project spaces, including:

- GitHub Issues
- Pull Requests
- Discussions
- Code Reviews
- Repository documentation
- Translation and review activities

---

# Acknowledgements

This Code of Conduct is inspired by established open source community practices and has been adapted for the Punjabi Python Documentation Translation Project.
To report a violation, email the PSF Conduct Working Group at <conduct-wg@python.org>. You can also contact one of the coordinators listed in the [README](../README.en.md).
118 changes: 10 additions & 108 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,124 +1,26 @@
---
name: Bug Report
about: Report a bug, translation issue, validation error, or documentation problem in the Punjabi translation project.
name: Bug report
about: Report a translation error, a build problem or a problem in this repository.
title: "[BUG] "
labels: bug
assignees: ""
---

# Bug Report
## What is wrong?

Thank you for helping improve the Punjabi (`pa`) translation of the Python documentation.
<!-- A short, clear description. For a translation error, include the English text and the Punjabi text. -->

Please provide as much information as possible to help us reproduce and resolve the issue.
## Where?

---

# Bug Summary

Provide a clear and concise description of the issue.

-

---

# Category

Select all that apply.

- [ ] Translation error
- [ ] Terminology inconsistency
- [ ] Formatting / reStructuredText markup
- [ ] Broken cross-reference
- [ ] Validation failure
- [ ] GitHub Actions
- [ ] Documentation issue
- [ ] Repository tooling
- [ ] Other

---
<!-- The page on docs.python.org/pa/ or the file, and the string if you know it. Translation fixes are made in Transifex, and we can help with that. -->

# Affected Documentation Area

Examples:

- Tutorial
- Using Python
- Standard Library
- HOWTO
- FAQ
- Reference
- C API
- What's New
- Repository documentation

Documentation area:

-

Affected file(s):

- `example.po`

---

# Steps to Reproduce
## Steps to reproduce (if any)

1.
2.
3.

---

# Expected Behavior

Describe what you expected to happen.

-

---

# Actual Behavior

Describe what actually happened.

-

---

# Validation Output (if applicable)

Include any relevant validation output.

```text
msgfmt
sphinx-lint
HTML build
Nitpicky build
GitHub Actions
```

---

# Environment

- Operating System:
- Python Version:
- Sphinx Version:
- gettext Version:

---

# Additional Information

Include anything that may help reproduce or understand the issue.

Examples:
## Expected and actual result

- screenshots
- logs
- source English text
- suggested translation
- related issue or discussion
<!-- What you expected, and what happened instead. Paste any error output here. -->

-
## Suggested fix (optional)
20 changes: 10 additions & 10 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
blank_issues_enabled: true

contact_links:
- name: Python Documentation Translation Project
- name: Python documentation translations (Developer's Guide)
url: https://devguide.python.org/documentation/translations/
about: Learn about the official Python Documentation Translation project and its workflow.
about: How Python documentation translations work.

- name: Python Documentation Translation on Transifex
- name: Translate on Transifex
url: https://explore.transifex.com/python-doc/python-newest/
about: Access the official Python Documentation translation platform.
about: Translate and review the Punjabi (pa) strings.

- name: Project Documentation
url: https://github.com/BHUVANSH855/python-docs-pa#readme
about: Read the README, contribution guidelines, style guide, and glossary before opening an issue.
- name: README
url: https://github.com/python/python-docs-pa#readme
about: Start here to learn how this project works.

- name: Contribution Guidelines
url: https://github.com/BHUVANSH855/python-docs-pa/blob/3.15/CONTRIBUTING.md
about: Learn how to contribute translations, reviews, and repository improvements.
- name: Contributing guide
url: https://github.com/python/python-docs-pa/blob/3.15/CONTRIBUTING.md
about: How to contribute translations, reviews and repository improvements.
89 changes: 8 additions & 81 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,94 +1,21 @@
---
name: Feature Request
name: Feature request
about: Suggest an improvement for the Punjabi translation project.
title: "[FEATURE] "
labels: enhancement
assignees: ""
---

# Feature Request
## What would you like to improve?

Thank you for helping improve the Punjabi (`pa`) translation of the Python documentation.
<!-- A short, clear description of the idea. -->

Please describe your idea using the sections below.
## Why would it help?

---

# Feature Summary

Provide a clear and concise description of the proposed improvement.

-

---

# Category

Select all that apply.

- [ ] Translation improvement
- [ ] Documentation improvement
- [ ] Glossary enhancement
- [ ] Style Guide improvement
- [ ] Contributor experience
- [ ] Validation workflow
- [ ] GitHub Actions / CI
- [ ] Repository tooling
- [ ] Automation
- [ ] Other
<!-- For example: better translation quality, easier contributing, less maintenance. -->

---

# Motivation

Why would this improvement benefit the project?

Examples:

- improve translation quality
- improve consistency
- simplify contributor workflow
- improve validation
- reduce maintenance effort

-

---

# Proposed Solution

Describe your proposed solution.

-

---

# Alternatives Considered

Describe any alternative approaches you considered.

-

---

# Additional Context

Include any useful information such as:

- examples
- screenshots
- references
- related discussions
- related issues
- relevant Python documentation

-

---
## Proposed solution (optional)

# Contributor Checklist
## Anything else?

- [ ] This proposal aligns with the goals of the project.
- [ ] I searched for similar feature requests before creating this issue.
- [ ] I have provided enough information for discussion.
- [ ] I am willing to help implement this feature (optional).
<!-- Examples, references or related issues. -->
Loading
Loading