Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

43 lines (25 loc) · 1.5 KB

Contributing to the High-Throughput API Rate Limiter

First off, thank you for considering contributing! It's people like you that make the open-source community such a great place.

How Can I Contribute?

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the project.

Development Setup

  1. Fork the repository and clone it to your local machine.
  2. Make sure you have Java 21, Maven, and Docker installed.
  3. Build the project using docker-compose up --build -d.
  4. Run the tests to ensure everything is set up correctly.

Reporting Bugs

... (keep the existing content)

Suggesting Enhancements

... (keep the existing content)

Submitting a Pull Request

  1. Fork the repository and create your branch from main.
  2. Make your changes and ensure that the tests pass by running ./mvnw test in each service directory.
  3. Add your changes to the CHANGELOG.md file (if applicable).
  4. Open a pull request and provide a clear and concise description of your changes.

Finding an Issue to Work On

Check out our issues labeled as "good first issue". These are a great place to start!

Styleguides

Git Commit Messages

... (keep the existing content)

Java Styleguide