|
| 1 | +# Contributing to Asclepios AI |
| 2 | + |
| 3 | +Thank you for your interest in contributing to **Asclepios AI**!\ |
| 4 | +We welcome contributions that help improve the platform, documentation, |
| 5 | +models, and code quality. |
| 6 | + |
| 7 | +------------------------------------------------------------------------ |
| 8 | + |
| 9 | +## 🚀 How to Contribute |
| 10 | + |
| 11 | +### 1. Fork the Repository |
| 12 | + |
| 13 | +Click the **Fork** button at the top of the project repository to create |
| 14 | +your own copy. |
| 15 | + |
| 16 | +### 2. Clone Your Fork |
| 17 | + |
| 18 | +``` bash |
| 19 | +git clone git@github.com:MIT-Emerging-Talent/ELO2_Asclepios_Ai.git |
| 20 | +cd asclepios-ai |
| 21 | +``` |
| 22 | + |
| 23 | +### 3. Create a New Branch |
| 24 | + |
| 25 | +Always create a feature or fix branch in your fork: |
| 26 | + |
| 27 | +``` bash |
| 28 | +git checkout -b feature/new-enhancement |
| 29 | +``` |
| 30 | + |
| 31 | +------------------------------------------------------------------------ |
| 32 | + |
| 33 | +## 🧪 Development Setup |
| 34 | + |
| 35 | +Install dependencies: |
| 36 | + |
| 37 | +``` bash |
| 38 | +pip install -r requirements.txt |
| 39 | +``` |
| 40 | + |
| 41 | +Ensure you are using **Python 3.10+**. |
| 42 | + |
| 43 | +------------------------------------------------------------------------ |
| 44 | + |
| 45 | +## 📝 Code Standards |
| 46 | + |
| 47 | +To maintain consistency, contributors are expected to follow: |
| 48 | + |
| 49 | +### ✔️ Python Standards |
| 50 | + |
| 51 | +- Use **PEP8** formatting. |
| 52 | + |
| 53 | +- Run linters before submitting a PR: |
| 54 | + |
| 55 | + ``` bash |
| 56 | + ruff check . |
| 57 | + ``` |
| 58 | + |
| 59 | +### ✔️ Markdown Standards |
| 60 | + |
| 61 | +Markdown files are checked using: - `.markdownlint.yml` |
| 62 | + |
| 63 | +Run markdown linting: |
| 64 | + |
| 65 | +``` bash |
| 66 | +markdownlint . |
| 67 | +``` |
| 68 | + |
| 69 | +### ✔️ Folder & File Naming |
| 70 | + |
| 71 | +We follow `.ls-lint.yml` rules for consistent file naming across the |
| 72 | +project. |
| 73 | + |
| 74 | +------------------------------------------------------------------------ |
| 75 | + |
| 76 | +## 🧪 Testing |
| 77 | + |
| 78 | +Ensure all code added or modified includes tests where applicable. |
| 79 | + |
| 80 | +Run tests: |
| 81 | + |
| 82 | +``` bash |
| 83 | +pytest |
| 84 | +``` |
| 85 | + |
| 86 | +------------------------------------------------------------------------ |
| 87 | + |
| 88 | +## 🔄 Submitting a Pull Request (PR) |
| 89 | + |
| 90 | +1. Commit your changes: |
| 91 | + |
| 92 | + ``` bash |
| 93 | + git commit -m "Add: new enhancement" |
| 94 | + ``` |
| 95 | + |
| 96 | +2. Push to your fork: |
| 97 | + |
| 98 | + ``` bash |
| 99 | + git push origin feature/new-enhancement |
| 100 | + ``` |
| 101 | + |
| 102 | +3. Create a Pull Request on GitHub. |
| 103 | + |
| 104 | +**Include the following in your PR:** - Clear description of the |
| 105 | +change - Related issue number (if applicable) - Screenshots (for |
| 106 | +UI/visual tools) - Test results (if required) |
| 107 | + |
| 108 | +------------------------------------------------------------------------ |
| 109 | + |
| 110 | +## 💬 Community Guidelines |
| 111 | + |
| 112 | +- Be respectful and helpful. |
| 113 | +- Use clear communication. |
| 114 | +- Provide meaningful commit messages. |
| 115 | +- Document major changes clearly. |
| 116 | + |
| 117 | +------------------------------------------------------------------------ |
| 118 | + |
| 119 | +## 📄 License |
| 120 | + |
| 121 | +By contributing, you agree that your contributions will be licensed |
| 122 | +under the **MIT License**, included in this repository. |
| 123 | + |
| 124 | +------------------------------------------------------------------------ |
| 125 | + |
| 126 | +Thank you for helping make **Asclepios AI** better!\ |
| 127 | +For questions or suggestions, feel free to open an issue. |
0 commit comments