Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 2.44 KB
Raw

Contributing

Thank you for your interest in contributing to this project!

Getting Started

  1. Read the contribution guide.
  2. Fork the project.
  3. Create a new branch for your work.
  4. Make the necessary changes.
  5. Test your changes. (Everything created should be tested at least 3 times on your machine).
  6. Create a pull request to the main branch.

Contribution Guide

Terms and Concepts

  • Pull request: A request to incorporate changes from a secondary branch to the main branch.
  • Branch: A copy of a main branch to work on specific changes.
  • Merge: The process of incorporating changes from a secondary branch to the main branch.

How to Contribute

You can contribute to this project in various ways. Here are some suggestions:

  • Test on your machine: You can follow our recommendations and test on your machine.
  • Report bugs: If you find a bug, open a New Issue in the project repository.
  • Submit bug fixes: If you find a solution for a bug, submit a pull request.
  • Add new features: If you have an idea for a new feature, submit a pull request.
  • Write documentation: Documentation is always needed. If you have experience in writing documentation, submit a pull request.

How to Make a Pull Request

To make a pull request, follow these steps:

  1. Fork the project.
  2. Create a new branch for your work.
  3. Make the necessary changes.
  4. Test your changes.
  5. Create a pull request to the main branch.

Here are some tips for making a pull request:

  • Ensure that your changes are tested at least 3 times.
  • Include a clear description of your work in the pull request.
  • If you are adding a new feature to the Table Of Contents list, provide instructions on how to use it.

How to Be an Active Contributor

Here are some tips to be an active contributor:

  • Be friendly and open to feedback.
  • Respond to questions and comments.
  • Be patient. The pull request review process may take some time.

Important Note: Some things work on Windows and MAC, such as third-party programs like Kleopatra, KeePassXC, among others, but PLEASE NOTE that our focus is on Linux, more precisely Debian, so always consider this when following guides more related to the machine's operating system.

Thank you for contributing to this project!