Contributing to Curve¶

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to Curve. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct¶

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?¶

Reporting Bugs¶

This section guides you through submitting a bug report for Curve. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Use a clear and descriptive title for the issue to identify the problem.
Describe the exact steps to reproduce the problem in as many details as possible.
Provide specific examples to demonstrate the steps.
Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
Explain which behavior you expected to see instead and why.
Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

Suggesting Enhancements¶

This section guides you through submitting an enhancement suggestion for Curve, including completely new features and minor improvements to existing functionality.

Use a clear and descriptive title for the issue to identify the suggestion.
Provide a step-by-step description of the suggested enhancement in as many details as possible.
Provide specific examples to demonstrate the steps.
Describe the current behavior and explain which behavior you expected to see instead and why.

Pull Requests¶

The process described here has several goals:

Maintain Curve's quality
Fix problems that are important to users
Engage the community in working toward the best possible Curve
Enable a sustainable system for Curve's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

Follow all instructions in the template
Follow the styleguides
After you submit your pull request, verify that all status checks are passing

Styleguides¶

Git Commit Messages¶

Use the present tense ("Add feature" not "Added feature")
Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
Limit the first line to 72 characters or less
Reference issues and pull requests liberally after the first line

Java Styleguide¶

Use Google Java Style Guide
Use 4 spaces for indentation
Use meaningful variable and method names
Add Javadoc for public methods and classes

Development Setup¶

Clone the repository

git clone https://github.com/closeup1202/curve.git

Build the project
```
./gradlew build
```
Run tests
```
./gradlew test
```

Project Structure¶

core: Pure domain model (No framework dependencies)
spring: Spring Framework adapter
kafka: Kafka adapter
spring-boot-autoconfigure: Spring Boot auto-configuration
sample: Sample application

Need Help?¶

If you have any questions, please feel free to reach out to us via GitHub Issues.

Thank you for contributing! 🚀