From 80853c6e8dc9a1d4ab051dd7cad506f315d7e47c Mon Sep 17 00:00:00 2001 From: Devayudh Chatterjee Date: Wed, 18 Feb 2026 00:57:11 +0530 Subject: [PATCH] Add organization guidelines to README Added comprehensive organization guidelines covering compliance, contribution workflow, pull request requirements, code quality standards, CI/CD requirements, governance policy, and professional conduct. --- profile/README.md | 103 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 profile/README.md diff --git a/profile/README.md b/profile/README.md new file mode 100644 index 0000000..ee1ce7b --- /dev/null +++ b/profile/README.md @@ -0,0 +1,103 @@ +# Organization Guidelines + +This repository contains the official policies, standards, and governance rules for all repositories under this organization. + +All members and collaborators are required to read and comply with these guidelines before contributing to any project. + +--- + +## โš ๏ธ Mandatory Compliance + +These guidelines apply to: + +- All public repositories +- All private repositories +- All members and collaborators +- All contributions (code, documentation, CI, automation, etc.) + +Failure to follow these standards may result in: + +- Pull request rejection +- Revoked repository access +- Removal from the organization + +--- + +## ๐Ÿ” Contribution Workflow (Required) + +All development work **must follow this workflow**: + +1. **Fork the repository** before starting any work. +2. Create a feature or fix branch in your fork. +3. Do **not** push directly to the upstream repository. +4. Submit all changes via a pull request from your fork. +5. Wait for review and approval before merging. + +Direct pushes to protected branches are strictly prohibited. + +--- + +## ๐Ÿ›  Pull Request Requirements + +All pull requests must: + +- Reference a related issue (where applicable) +- Clearly describe the changes made +- Follow repository coding standards +- Pass all automated checks +- Be reviewed and approved before merging + +--- + +## ๐Ÿงน Code Quality Standards + +Every project repository must enforce: + +- **Strict linting rules** +- **Consistent code formatting** +- **Automated checks in CI** + +Projects are expected to: +- Use industry-standard linters and formatters +- Reject code that does not meet defined quality thresholds +- Keep configuration checked into the repository + +--- + +## ๐Ÿš€ CI/CD Requirements + +Each repository must maintain a functional CI/CD pipeline that: + +- Runs linting and formatting checks +- Executes tests where applicable +- Prevents merging when checks fail +- Supports automated deployment if relevant + +Repositories without CI enforcement may not accept contributions. + +--- + +## ๐Ÿ”’ Governance Policy + +- Organization-wide repositories (such as `.github`) require explicit approval from the organization owner before changes are made. +- Structural, workflow, or policy changes must be discussed and approved prior to implementation. +- No member may introduce breaking changes without approval. + +--- + +## ๐Ÿค Professional Conduct + +All contributors are expected to: + +- Communicate respectfully and professionally +- Accept constructive feedback +- Prioritize project stability and maintainability +- Follow security and best practices + +--- + +## ๐Ÿ“Œ Final Note + +These guidelines exist to ensure consistency, security, and long-term maintainability across the organization. + +By contributing to any repository within this organization, you acknowledge and agree to follow these policies.