Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (22 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.24 KB

Contributing to PCM

First off, thank you for considering contributing to PCM! It's people like you that make PCM such a great tool.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please search the issue tracker to see if the problem has already been reported. If you find a closed issue that seems like what you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Suggesting Enhancements

Feature requests are welcome! Please open an issue and describe the use case and the proposed solution.

Pull Requests

  1. Fork the repo and create your branch from develop.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Styleguides

Java Styleguide

We follow the standard Spring Boot coding conventions. Please ensure your IDE is configured to use them.

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