wehub-resource-sync
36 lines
1.5 KiB
Markdown
36 lines
1.5 KiB
Markdown
# Contributing to V-Start
|
|
|
|
First off, thank you for considering contributing to V-Start! We welcome any help, whether it's reporting a bug, suggesting a new feature, or writing code.
|
|
|
|
## How Can I Contribute?
|
|
|
|
### 🐛 Reporting Bugs
|
|
|
|
If you find a bug, please open an issue on our GitHub repository. When you report a bug, please include:
|
|
|
|
* **A clear and descriptive title.**
|
|
* **Steps to reproduce the bug.** Be as specific as possible.
|
|
* **What you expected to happen** versus what actually happened.
|
|
* **Screenshots or screen recordings** if they help illustrate the issue.
|
|
|
|
### ✨ Suggesting Enhancements
|
|
|
|
If you have an idea for a new feature or an improvement to an existing one, please open an issue to start a discussion. This allows us to coordinate our efforts and prevent duplication of work.
|
|
|
|
Please provide:
|
|
|
|
* **A clear and descriptive title.**
|
|
* **A detailed description of the proposed enhancement** and why you think it would be valuable.
|
|
* **Any mockups or examples** that might help explain your idea.
|
|
|
|
### 🔧 Pull Requests
|
|
|
|
We are happy to review pull requests! If you'd like to contribute code, please follow these steps:
|
|
|
|
1. **Fork the repository** and create your branch from `main`.
|
|
2. **Make your changes.** Please ensure your code follows the existing style of the project.
|
|
3. **Add comments** to any complex or non-obvious parts of your code.
|
|
4. **Ensure your code lints** without any errors.
|
|
5. **Open a pull request** with a clear title and a detailed description of the changes you've made.
|
|
|
|
Thank you for helping make V-Start better! |