Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 2.95 KB

CONTRIBUTION.md

File metadata and controls

65 lines (40 loc) · 2.95 KB

Contributing to RESTful APE

Contributions are welcome and greatly appreciated! Every little bit helps, and credit will always be given.

Types of Contributions

Report Bugs

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Best Coding Practices for Java and Spring Boot

When contributing code, please ensure it adheres to the following best practices:

  • Follow Java and Spring Boot best practices: This includes proper use of annotations, configuration management, and exception handling. Utilize Spring's dependency injection to keep your code clean and testable.
  • Code Style: Adhere to the Google Java Style Guide to ensure consistency and readability in the codebase.
  • Documentation: All public methods and classes should be documented with Javadoc comments. This is crucial for maintainability and for other contributors to understand your code.
  • Testing: Include unit tests for new features and bug fixes. We use JUnit and Spring Boot Test for testing. Aim for high coverage to ensure quality and prevent regressions.

Get Started!

Ready to contribute? Here's how to set up RESTful APE for local development:

  1. Download a copy of RESTful APE locally.
  2. Fork the RESTful APE repo on GitHub.
  3. Clone the project to your own machine.
  4. Make changes to the code. Ensure your changes adhere to the coding practices mentioned above and pass all tests.
  5. Commit and push your changes.
  6. Open a pull request.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests proving the new feature works or the bug is fixed.
  2. If the pull request adds functionality, update the documentation accordingly.
  3. Ensure your code changes are compatible with the latest versions of Java and Spring Boot used by the project.

Code of Conduct

Please note that the RESTful APE project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.