-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
88 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
# Contributing to Host Route Library | ||
|
||
We welcome contributions to the Host Route Library project! Whether you are reporting a bug, suggesting an enhancement, or creating a pull request, we appreciate your support and are here to help make the process as smooth as possible. | ||
|
||
## How to Contribute | ||
|
||
### Reporting Bugs | ||
|
||
If you encounter a bug or have a question, please open an issue on GitHub. When reporting a bug, provide as much detail as possible to help us diagnose and fix the issue efficiently. This includes: | ||
|
||
- A clear and descriptive title. | ||
- Steps to reproduce the issue. | ||
- Expected behavior. | ||
- Actual behavior. | ||
- Relevant logs, screenshots, or code snippets. | ||
|
||
### Suggesting Enhancements | ||
|
||
Enhancement suggestions are also welcome! Please open an issue and describe your idea in detail. Consider including: | ||
|
||
- A clear and descriptive title. | ||
- A detailed description of the enhancement and why it would be useful. | ||
- Any examples or code snippets if applicable. | ||
|
||
### Submitting Pull Requests | ||
|
||
To implement a new feature, fix a bug, or improve documentation: | ||
|
||
1. **Fork the Repository** | ||
|
||
Create a personal fork of the repository on GitHub. | ||
|
||
2. **Clone the Fork** | ||
|
||
```sh | ||
git clone https://github.com/YidiDev/gin-host-route.git | ||
cd gin-host-route | ||
``` | ||
|
||
3. **Create a New Branch** | ||
|
||
Use a descriptive branch name that includes the purpose of the branch: | ||
|
||
```sh | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
4. **Make Changes** | ||
|
||
Implement your changes following the project's coding style. | ||
5. **Commit Changes** | ||
Write a concise commit message: | ||
```sh | ||
git commit -am 'Add feature/bugfix-xyz' | ||
``` | ||
6. **Push the Branch** | ||
Push your branch to your fork on GitHub: | ||
```sh | ||
git push origin feature/your-feature-name | ||
``` | ||
7. **Create a Pull Request** | ||
Open a pull request on the original repository. Include a clear and descriptive title and a detailed description of your changes. | ||
### Code Style and Standards | ||
Please follow these conventions to maintain consistency: | ||
- Use **Go** coding conventions. | ||
- Write **unit tests** for new features and bug fixes. | ||
- Ensure existing tests pass by running `go test ./...`. | ||
### Code of Conduct | ||
By participating in this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). | ||
## Questions | ||
If you have any questions or need further assistance, feel free to open an issue or reach out to the maintainers of this project. | ||
Thank you for contributing! |