|
| 1 | +# Contribution Guidelines |
| 2 | + |
| 3 | +Thank you for your interest in contributing to **Vectra**! |
| 4 | +We’re thrilled to collaborate with developers like you to make this project more powerful, stable, and innovative. |
| 5 | + |
| 6 | +Whether you’re here to: |
| 7 | + |
| 8 | +- 🐞 Report a bug |
| 9 | +- 💬 Discuss the current state of the project |
| 10 | +- 🔧 Submit a fix |
| 11 | +- 💡 Propose a new feature |
| 12 | +- 🧭 Become a maintainer |
| 13 | + |
| 14 | +We welcome and appreciate your contribution! |
| 15 | + |
| 16 | +## Development Workflow |
| 17 | + |
| 18 | +We use **GitHub** to manage our source code, issues, feature requests, and pull requests. |
| 19 | +All changes to the codebase are made through **Pull Requests (PRs)** — following the principles of [GitHub Flow](https://guides.github.com/introduction/flow/index.html). |
| 20 | + |
| 21 | +### How to Contribute Code |
| 22 | + |
| 23 | +1. **Fork** the repository and create a new branch from `main`. |
| 24 | + Use a descriptive branch name, e.g.: |
| 25 | + - `feature/vectractl-new-command` |
| 26 | + - `fix/vectractl-config-bug` |
| 27 | +2. **Implement your changes** — write clean, maintainable, and well-documented code. |
| 28 | +3. **Write tests** for any new or modified functionality. |
| 29 | +4. **Update documentation** if your changes affect public APIs or usage. |
| 30 | +5. **Run all tests** and ensure they pass successfully. |
| 31 | +6. **Follow coding standards** — maintain consistency with the existing style and linting rules. |
| 32 | +7. **Submit a Pull Request (PR)** including: |
| 33 | + - A clear and concise description of your changes. |
| 34 | + - References to related issues or discussions. |
| 35 | + - Screenshots, logs, or examples where relevant. |
| 36 | + |
| 37 | +💡 *We actively review all pull requests and provide constructive feedback. Your ideas and improvements help shape Vectra for everyone.* |
| 38 | + |
| 39 | +## Reporting Bugs & Issues |
| 40 | + |
| 41 | +We use [GitHub Issues](https://github.com/cortexiumlabs/vectractl/issues) to track bugs, enhancements, and discussions. |
| 42 | +To report a bug, [open a new issue](https://github.com/cortexiumlabs/vectractl/issues/new) and include as much detail as possible: |
| 43 | + |
| 44 | +- **Summary** – A short description of the issue. |
| 45 | +- **Steps to Reproduce** – Include exact steps or a minimal reproducible example (preferably in C#). |
| 46 | +- **Expected Behavior** – What you expected to happen. |
| 47 | +- **Actual Behavior** – What actually happens. |
| 48 | +- **Additional Context** – Logs, screenshots, or environment details that help diagnose the issue. |
| 49 | + |
| 50 | +🔍 *Clear, reproducible reports help us resolve issues faster and maintain higher project quality.* |
| 51 | + |
| 52 | +## Code of Conduct |
| 53 | + |
| 54 | +By participating in this project, you agree to help foster a welcoming and inclusive environment for everyone. |
| 55 | +Be respectful, constructive, and considerate in all interactions — collaboration is key to success. |
| 56 | + |
| 57 | +## License |
| 58 | + |
| 59 | +By contributing to **VectraCTL**, you agree that your contributions will be licensed under the terms of the [Apache-2.0](https://opensource.org/license/Apache-2.0), which governs this project. |
| 60 | + |
| 61 | +If you have any questions about licensing or contributions, please reach out to the maintainers. |
| 62 | + |
| 63 | +## ❤️ Thank You |
| 64 | + |
| 65 | +Your time and expertise make **VectraCTL** better every day. |
| 66 | +Together, we can build a flexible, open, and powerful CLI tool for everyone. |
0 commit comments