|
| 1 | +# Contributing to DevCore-Software-Design-Principles-Handbook |
| 2 | + |
| 3 | +Thank you for considering contributing to the `DevCore-Software-Design-Principles-Handbook`! This project aims to be a definitive, expertly curated compendium of essential software engineering principles and design patterns, serving as a vital resource for developers at all levels. |
| 4 | + |
| 5 | +We welcome contributions that help maintain and elevate the quality and comprehensiveness of this handbook. |
| 6 | + |
| 7 | +## 1. Code of Conduct |
| 8 | + |
| 9 | +This project adheres to the Contributor Covenant Code of Conduct. Please read the full [Code of Conduct](https://github.com/chirag127/DevCore-Software-Design-Principles-Handbook/blob/main/CODE_OF_CONDUCT.md) to understand what actions are acceptable. |
| 10 | + |
| 11 | +## 2. How to Contribute |
| 12 | + |
| 13 | +We accept contributions in various forms: |
| 14 | + |
| 15 | +* **Submitting a Pull Request:** The best way to propose changes is to fork this repo, commit your changes to a new branch, and open a pull request. |
| 16 | +* **Reporting Issues:** If you find any errors, omissions, or areas for improvement, please open an issue on the GitHub repository. |
| 17 | +* **Suggesting New Content:** Have a principle or pattern that's missing? Open an issue to discuss its inclusion. |
| 18 | + |
| 19 | +## 3. Development Setup (If applicable) |
| 20 | + |
| 21 | +While this handbook is primarily documentation, if any code examples or scripts were to be introduced, the following would apply: |
| 22 | + |
| 23 | +**Note:** As of late 2025, this project focuses on documentation. If executable components were added, they would likely follow a Python stack standard: |
| 24 | + |
| 25 | +1. **Clone the Repository:** |
| 26 | + bash |
| 27 | + git clone https://github.com/chirag127/DevCore-Software-Design-Principles-Handbook.git |
| 28 | + cd DevCore-Software-Design-Principles-Handbook |
| 29 | + |
| 30 | + |
| 31 | +2. **Setup Python Environment (using uv): |
| 32 | + bash |
| 33 | + uv venv |
| 34 | + source .venv/bin/activate |
| 35 | + uv pip install -r requirements-dev.txt |
| 36 | + |
| 37 | + |
| 38 | +3. **Linting and Formatting (using Ruff): |
| 39 | + bash |
| 40 | + ruff check . |
| 41 | + ruff format . |
| 42 | + |
| 43 | + |
| 44 | +4. **Testing (using Pytest): |
| 45 | + bash |
| 46 | + pytest |
| 47 | + |
| 48 | + |
| 49 | +## 4. Contribution Guidelines |
| 50 | + |
| 51 | +* **Clarity and Conciseness:** Ensure all additions are clear, concise, and directly relevant to software design principles. |
| 52 | +* **Accuracy:** Verify all information before submitting. Cite sources where appropriate. |
| 53 | +* **Structure:** Adhere to the existing structure and formatting of the handbook. Use Markdown effectively. |
| 54 | +* **Positive Contributions:** Focus on constructive improvements. All contributions must align with the project's goal of being a professional, expert-level resource. |
| 55 | +* **Respect:** Maintain a respectful and professional tone in all communications. |
| 56 | + |
| 57 | +## 5. Workflow |
| 58 | + |
| 59 | +1. **Fork the Repository:** Create your own fork of the project. |
| 60 | +2. **Create a Branch:** Make your changes in a new branch (e.g., `fix/typo-in-solid`, `feat/add-hexagonal-architecture`). |
| 61 | +3. **Commit Changes:** Write clear, concise commit messages. |
| 62 | +4. **Submit Pull Request:** Open a PR against the `main` branch of `chirag127/DevCore-Software-Design-Principles-Handbook`. |
| 63 | +5. **Review:** Your PR will be reviewed by the maintainers. |
| 64 | + |
| 65 | +## 6. Reporting Security Vulnerabilities |
| 66 | + |
| 67 | +If you discover a security vulnerability, please follow the instructions in the [SECURITY.md](https://github.com/chirag127/DevCore-Software-Design-Principles-Handbook/blob/main/SECURITY.md) file. |
| 68 | + |
| 69 | +## 7. AI Agent Directives |
| 70 | + |
| 71 | +This repository is governed by specific AI agent directives, detailed in the [AGENTS.md](https://github.com/chirag127/DevCore-Software-Design-Principles-Handbook/blob/main/AGENTS.md) file. Adherence to these directives ensures consistency and quality. |
| 72 | + |
| 73 | +By contributing, you agree that your contributions will be licensed under the terms of the [CC BY-NC 4.0 License](https://github.com/chirag127/DevCore-Software-Design-Principles-Handbook/blob/main/LICENSE). |
0 commit comments