Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
85 lines (51 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

85 lines (51 loc) · 1.99 KB

Contributing to Corridor

Thank you for your interest in contributing to Corridor! We welcome contributions of all kinds, including bug reports, feature requests, code, and documentation improvements.

How to Contribute

1. Fork the Repository

Click the "Fork" button at the top right of the Corridor GitHub page to create your own copy of the repository.

2. Clone Your Fork

git clone https://github.com/your-username/corridor.git
cd corridor

3. Create a Branch

Create a new branch for your changes:

git checkout -b my-feature-or-bugfix

4. Make Your Changes

  • Follow the existing code style and conventions.
  • Add or update tests as appropriate.
  • Update documentation if your changes affect usage or configuration.

5. Run Tests

Before submitting your changes, make sure all tests pass:

go test ./...

6. Commit and Push

Commit your changes with a clear message:

git add .
git commit -m "Describe your change"
git push origin my-feature-or-bugfix

7. Open a Pull Request

Go to your fork on GitHub and open a pull request (PR) against the main branch of the upstream repository. Please include a clear description of your changes and reference any related issues.

Code of Conduct

By participating in this project, you agree to abide by the Contributor Covenant Code of Conduct.

Reporting Issues

If you find a bug or have a feature request, please open an issue and provide as much detail as possible.

Style Guide

  • Use gofmt to format your code.
  • Write clear, concise commit messages.
  • Document exported functions and types.
  • Add or update unit tests for new features or bug fixes.

Questions

If you have questions or need help, feel free to open an issue or start a discussion.

Thank you for helping make Corridor better!