|
| 1 | +# Contributing to Trood Metarepository |
| 2 | + |
| 3 | +Thank you for contributing to Trood Core! |
| 4 | + |
| 5 | +All of the necessary information can be found in our [code of conduct](https://www.notion.so/trood/Trood-Testament-4a08910e65c04cf39253d0fb8f06ef59) as well as in [GitHub discussions](https://github.com/orgs/TroodInc/discussions). |
| 6 | + |
| 7 | +## Proposing changes |
| 8 | + |
| 9 | +The best way to propose a change is to start a discussion on our GitHub repository. |
| 10 | + |
| 11 | +- First, write a short problem statement, which clearly and briefly describes the problem you want to solve independently from any specific solution. It doesn't need to be long or formal, but it's difficult to consider a solution in absence of a clear understanding of the problem. |
| 12 | + |
| 13 | +- Next, write a short solution proposal. How can the problem (or set of problems) you have stated above be addressed? What are the pros and cons of your approach? Again, keep it brief and informal. This isn't a specification, but rather a starting point for a conversation. |
| 14 | + |
| 15 | +- By effectively engaging with the our team and community early in your process, we're better positioned to give you feedback and understand your pull request once you open it. If the first thing we see from you is a big changeset, we're much less likely to respond to it in a timely manner. |
| 16 | + |
| 17 | + |
| 18 | +## 🛠 **How to Contribute** |
| 19 | + |
| 20 | +We welcome contributions in the following forms: |
| 21 | + |
| 22 | +1. **Submitting new repositories:** Share tools, libraries, and solutions that fit within our categories. |
| 23 | +2. **Improving documentation:** Enhance and refine our documentation for better usability. |
| 24 | +3. **Fixing bugs:** Identify and fix issues in existing repositories. |
| 25 | +4. **Enhancements:** Propose and implement new features or optimizations. |
| 26 | +5. **Code reviews:** Review and provide feedback on submitted pull requests. |
| 27 | + |
| 28 | +--- |
| 29 | + |
| 30 | +## 🚀 **Getting Started** |
| 31 | + |
| 32 | +1. **Fork the Repository:** Fork the project to your GitHub account. |
| 33 | +2. **Clone Your Fork:** |
| 34 | + ```bash |
| 35 | + git clone https://github.com/your-username/trood-metarepository.git |
| 36 | + cd trood-metarepository |
| 37 | + ``` |
| 38 | +3. **Set Up the Development Environment:** |
| 39 | + |
| 40 | +4. **Create a Branch:** |
| 41 | + ```bash |
| 42 | + git checkout -b feature/your-feature-name |
| 43 | + ``` |
| 44 | + Use the branch naming conventions listed below. |
| 45 | + |
| 46 | +--- |
| 47 | + |
| 48 | +## 📝 **Branch Naming Conventions** |
| 49 | + |
| 50 | +Branches should follow this structure: |
| 51 | +``` |
| 52 | +[type_of_change]/[feature_name] |
| 53 | +``` |
| 54 | +**Types of changes:** |
| 55 | +- `feature`: New features or enhancements. |
| 56 | +- `bug`: Fixes for bugs or issues. |
| 57 | +- `fix`: Minor fixes or optimizations. |
| 58 | +- `chore`: Maintenance tasks, like refactoring or dependency updates. |
| 59 | +
|
| 60 | +**Example:** |
| 61 | +``` |
| 62 | +feature/AI_search |
| 63 | +``` |
| 64 | +
|
| 65 | +--- |
| 66 | +
|
| 67 | +## 🔄 **Commit Messages** |
| 68 | +
|
| 69 | +A good commit message should be concise and descriptive. Format: |
| 70 | +``` |
| 71 | +[type]: [description] |
| 72 | +``` |
| 73 | +**Types:** |
| 74 | +- `feat`: For new features. |
| 75 | +- `fix`: For bug fixes. |
| 76 | +- `docs`: For changes to documentation. |
| 77 | +- `refactor`: For code refactoring. |
| 78 | +- `test`: For adding or updating tests. |
| 79 | +
|
| 80 | +**Example:** |
| 81 | +``` |
| 82 | +feat: Implement AI-powered search functionality |
| 83 | +``` |
| 84 | +
|
| 85 | +--- |
| 86 | +
|
| 87 | +## 🔍 **Pull Requests** |
| 88 | +
|
| 89 | +Before submitting a pull request: |
| 90 | +1. Ensure your branch is up to date with the `main` branch: |
| 91 | + ```bash |
| 92 | + git pull origin main |
| 93 | + ``` |
| 94 | +2. Run tests and ensure there are no errors. |
| 95 | +3. Submit the pull request, linking the related ClickUp task if applicable. |
| 96 | +
|
| 97 | +--- |
| 98 | +
|
| 99 | +## 🔧 **Code Reviews** |
| 100 | +
|
| 101 | +We follow these guidelines for code reviews: |
| 102 | +- **Constructive Feedback:** Reviewers provide feedback that focuses on the code and not the person. |
| 103 | +- **Code Quality:** Ensure code follows the project’s style and standards. |
| 104 | +- **Automated Comments:** If a pull request receives **more than 7 comments** or **extends to 3 iterations**, it will be closed and reevaluated. |
| 105 | +
|
| 106 | +--- |
| 107 | +
|
| 108 | +## 📂 **File and Directory Structure** |
| 109 | +Ensure you place contributions in the appropriate directory under the relevant modules: |
| 110 | +``` |
| 111 | +/trood/ |
| 112 | + ├── business-objects/ |
| 113 | + ├── processes-and-events/ |
| 114 | + ├── infrastructure-devops/ |
| 115 | + ├── data-analysis/ |
| 116 | + ├── front-end/ |
| 117 | + ├── security/ |
| 118 | + ├── blockchain/ |
| 119 | + └── human-workflow/ |
| 120 | +``` |
| 121 | +
|
| 122 | +--- |
| 123 | +
|
| 124 | +## ✅ **Contribution Checklist** |
| 125 | +Before submitting a contribution, make sure: |
| 126 | +- [ ] Code adheres to the project’s coding standards. |
| 127 | +- [ ] Documentation is updated where necessary. |
| 128 | +- [ ] Code has been tested locally. |
| 129 | +- [ ] You’ve followed the naming conventions and branch policies. |
| 130 | +
|
| 131 | +--- |
| 132 | +
|
| 133 | +## 📜 **License** |
| 134 | +By contributing, you agree that your contributions will be licensed under the same license as this repository. See [LICENSE](./LICENSE) for details. |
| 135 | +
|
| 136 | +--- |
| 137 | +
|
| 138 | +We appreciate your efforts and contributions! 🎉 Let’s build something great together. |
0 commit comments