Skip to content

Latest commit

 

History

History
85 lines (43 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

85 lines (43 loc) · 3.02 KB
Raw

Contributing to CompactJV

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

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for CompactJV. 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 which reproduce the problem in as many details as possible.

  • 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 CompactJV, 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.

  • Describe the current behavior and explain which behavior you expected to see instead and why.

  • Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of CompactJV which the suggestion is related to.

Pull Requests

  • Fill in the required template

  • Do not include issue numbers in the PR title

  • Include screenshots and animated GIFs in your pull request whenever possible.

  • End all files with a newline

  • Follow the java styleguide

  • Document new code based on the Documentation Styleguide

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

Java Styleguide

All Java must adhere to Java styleguide.

Documentation Styleguide

  • Use Markdown for syntax

  • Reference methods and classes in backticks

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues that are clearly bugs.

  • enhancement - Issues that are feature requests or ideas for improvement.

  • help wanted - Issues that we need or would love help from the community to resolve.

  • documentation - Issues that are related to documentation.

  • duplicate - Issues that have already been opened before.

  • wontfix - Issues that we are not planning on fixing.