Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

67 lines (47 loc) · 2.29 KB

Contributing to Fast Shot

We love contributions! Whether you're fixing a bug, adding a new feature, or improving documentation, your help is greatly appreciated.

Please follow these guidelines to make the contribution process smooth and efficient.

Getting Started

  1. Fork the repository: Click the "Fork" button at the top right corner of the Fast Shot repository.

  2. Clone your fork:

    git clone git@github.com:<your-github-username>/fast-shot.git
  3. Create a branch:

    git checkout -b my-new-feature

    Choose a descriptive branch name that reflects the purpose of your contribution.

  4. Make your changes:

    • Follow the code style guidelines (see below).
    • Write tests to cover your changes (see below).
    • Commit your changes with clear and concise commit messages.
  5. Push your branch:

    git push origin my-new-feature
  6. Open a pull request:

    • Go to the original Fast Shot repository.
    • Click on the "Pull requests" tab.
    • Click "New pull request".
    • Select your fork and branch.
    • Provide a clear and descriptive title and description for your pull request.
    • Explain the changes you made and why they are necessary.
    • Link to any related issues.

Code Style Guidelines

  • Follow the standard Go formatting conventions. You can use the gofmt tool for automatic formatting.
  • Keep your code clean, readable, and well-documented.
  • Use meaningful names for variables, functions, and types.
  • Aim for concise and efficient code.

Testing

  • Write tests for all new code and bug fixes.
  • Use the Arrange-Act-Assert (AAA) pattern for test structure.
  • Use table-driven tests for testing multiple scenarios.
  • Ensure your tests have good coverage.

Code Review

Your pull request will be reviewed by maintainers. Be prepared to address any feedback or suggestions they provide.

License

By contributing to Fast Shot, you agree that your contributions will be licensed under the project's LICENSE file.

Questions

If you have any questions or need help, feel free to ask by opening an issue on the Fast Shot repository.

Thank you for contributing!