Thank you for your interest in contributing to EUR-UN projects! This document provides guidelines and standards for contributing to any repository within our organization.

• Code of Conduct
• Getting Started
• Workflow
• Coding Standards
• Commit Conventions
• Pull Request Guidelines
• Issue Reporting
• Language & Documentation
• License

All contributors are expected to adhere to our Code of Conduct. Please read it before participating.

1. Fork the target repository to your own GitHub account.
2. Clone your fork locally:

   git clone https://github.com/<your-username>/<repo-name>.git
   cd <repo-name>

3. Add upstream remote to stay in sync:

   git remote add upstream https://github.com/EUR-UN/<repo-name>.git

4. Install dependencies as documented in the project's README.

We use the Fork & Pull Request model.

fork → clone → branch → commit → push → pull request → review → merge

git fetch upstream
git checkout master
git merge upstream/master
git push origin master

• Write clean, readable code with meaningful variable and function names.
• Follow the existing code style of the project you are contributing to.
• Add comments for complex logic — but prefer self-documenting code.

• Clear output cells before committing (unless output is necessary for demonstration).
• Keep cells focused — one logical step per cell.
• Include markdown cells to explain methodology.

We follow Conventional Commits:

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

feat(monitor): add Telegram push notification support
fix(cert): resolve renewal timeout on slow networks
docs(readme): add Chinese translation for installation section

1. One PR = One logical change. Keep PRs focused and reviewable.
2. Fill out the PR template — describe what changed and why.
3. Reference related issues using Closes #123 or Fixes #456.
4. Ensure all checks pass — CI, lint, and tests must be green.
5. Be responsive to review feedback.
6. Squash commits if requested during review.

<type>(<scope>): <concise description>

Example: feat(api): add webhook retry mechanism

Please include:

• Environment: OS, language/runtime version, relevant tool versions
• Steps to reproduce: Minimal, reproducible steps
• Expected behavior: What you expected to happen
• Actual behavior: What actually happened
• Logs/screenshots: If applicable

Please include:

• Problem statement: What problem does this solve?
• Proposed solution: How should it work?
• Alternatives considered: What other approaches did you consider?

We maintain multilingual documentation (English / 中文 / Français) across most projects. When contributing documentation:

• Write the primary version in English.
• Add Chinese translations where the project already has bilingual docs.
• Add French translations where applicable.
• For Czech-specific tools, include Czech terminology where appropriate.

By contributing to any EUR-UN repository, you agree that your contributions will be licensed under the same license as the project (typically MIT or GPL-3.0). See each project's LICENSE file.

Thank you for helping make EUR-UN better! If you have questions, reach out at [email protected].