Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

42 lines (24 loc) · 1.8 KB

Contributing to SafePeek

First off, thanks for taking the time to contribute!

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for SafePeek. 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.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for SafePeek, 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.

Pull Requests

The process described here has several goals:

  • Maintain SafePeek's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible SafePeek

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

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

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Style Guide

Please follow the existing coding style to maintain consistency across the codebase.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.