Skip to content

Latest commit

 

History

History
77 lines (45 loc) · 3.72 KB

CONTRIBUTION.md

File metadata and controls

77 lines (45 loc) · 3.72 KB

Contributing to SecurePassManager

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

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to @fam007e.

How Can I Contribute?

Reporting Bugs

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

Before Submitting A Bug Report

  • Check the FAQ for a list of common questions and problems.
  • Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue using the Bug Report template and provide as much information as possible.

Suggesting Enhancements

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

Before Submitting An Enhancement Suggestion

  • Check if there's already a feature which provides that enhancement.
  • Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue using the Feature Request template and provide as much information as possible.

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.
  • Follow the C style guide.
  • End all files with a newline

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

C Styleguide

All C code must adhere to the Google C Style Guide.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests. These labels are automatically applied by our issue templates.

  • bug - Issues that are bugs.
  • enhancement - Issues that are feature requests.
  • documentation - Issues or pull requests related to documentation.
  • good first issue - Good for newcomers.

Getting Help

If you need help, you can ask questions on the issue tracker. You can use slash commands in issues and pull requests as defined in our issue-slash-cmd.yml workflow.

Release Process

Our release process is automated through the release.yml workflow. This process is triggered on pushes to the main branch that modify files in the src/ directory or the Makefile.

Thank you for contributing to SecurePassManager!