Project Contribution Guidelines: Agile Workflow, AI Policy, and Review Standards

[roshankumar0036singh]

Project Contribution Guidelines: Agile Workflow, AI Policy, and Review Standards

Description

Welcome to the auth-server repository! To maintain a high standard of code quality, structural integrity, and project transparency, all contributors must strictly adhere to the following workflow rules and engineering principles. Non-compliance will result in rejected pull requests or unassigned issues.

---

1. Agile Methodologies & Ticket Management

We run a disciplined Agile workflow. To keep velocity predictable and avoid merge conflicts:

• One Issue at a Time: You may only be assigned one issue at a time. You cannot request or claim a second ticket until your open Pull Request (PR) is fully merged, closed, or approved.
• Scope Creep: Stick strictly to the requirements outlined in the issue. Do not fix unrelated bugs or refactor unrelated files within the same branch.
• Branching & Commits: Create feature branches from main using descriptive naming conventions (e.g., feature/issue-12-jwt-rotation or bugfix/issue-45-cors-error).

---

2. Strict AI Contribution Policy (No Blind Copy-Pasting)

We embrace modern engineering tooling, but code integrity is paramount.

• AI Assistance is Allowed: You are welcome to use AI assistants (GitHub Copilot, ChatGPT, Claude, Gemini, etc.) for brainstorming, syntax reference, generating boilerplate setups, or writing unit test suites.
• Blind AI Usage is Strictly Prohibited: Do not blindly copy and paste AI-generated code. If you submit a PR containing code block patterns that clearly indicate an AI was copy-pasted without adaptation (e.g., redundant comments, generic placeholding, unoptimized logic, or missing edge cases), the PR will be closed immediately without a review.
• Ownership: You are 100% accountable for every single line of code you commit. If the AI writes it, you must understand it completely.

---

3. Strict Code Reviews & Technical Defense

Our review process is thorough, demanding, and technically rigorous.

• The "Defend Your Code" Rule: During the PR review or a sync session, maintainers can and will ask you detailed questions about your code architecture, choices, and performance trade-offs.
• Core Requirement: You must be able to confidently answer deep technical questions about how your implementation solves the problem in this project.

---

Checklist Before Submitting a Pull Request

Before you ping a maintainer for a review on your assigned ticket, ensure you can tick off all the boxes below:

• I am only working on this single assigned issue.
• My code aligns with the existing architecture of the auth-server project.
• I have tested the code locally, and all endpoints/functions behave as expected.
• I understand every line of code I wrote and am ready to defend my choices in the review.
• No generic, unedited AI boilerplate code remains in my changes.

---

How to get started?

If you agree to these rules and want to claim an open issue, please comment directly on that specific issue stating your intent, and wait for a maintainer to officially assign it to you. Happy coding!