Skip to content

Latest commit

 

History

History
86 lines (61 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

86 lines (61 loc) · 3.51 KB

Contributing to UpdateGuardian

First of all, thank you for considering to contribute to UpdateGuardian! Your contributions are greatly appreciated and will help improve this project for everyone.

This document provides guidelines and instructions for contributing to UpdateGuardian. By participating in this project, you agree to abide by the code of conduct.

Table of Contents

Code of Conduct

All contributors are expected to follow the Code of Conduct. Please read the Code of Conduct before contributing to ensure a welcoming and respectful environment for everyone.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Make your changes, test them, and commit them to your branch.
  5. Push your changes to your fork on GitHub.
  6. Create a pull request to merge your changes into the main repository.

How to Contribute

You can contribute to UpdateGuardian in several ways:

  1. Submit bug reports.
  2. Suggest new features or enhancements.
  3. Improve documentation.
  4. Write or improve tests.
  5. Contribute code by fixing bugs or implementing new features.

Pull Request Process

  1. Ensure that your fork is up to date with the latest changes from the main repository.
  2. Create a new branch for your changes.
  3. Make your changes, test them, and commit them to your branch.
  4. Push your changes to your fork on GitHub.
  5. Create a pull request to merge your changes into the main repository.
  6. Await review and approval from the maintainers. They may request changes or provide feedback.
  7. Once your changes have been approved, they will be merged into the main repository.

Important ⚠️

  • Please, type all your functions and variables with python type hints.
  • Document your code, functions, classes.
  • Write unittests for your code.
  • Don't write too long files.
  • Correctly format your code with pep8 conventions (You can format with PyCharm or prettier, or anything thta you like.)
  • Try to name your variables and functions with meaningful names (hardest job I know).

This will help me to maintain the codebase and make it more readable.

Reporting Bugs

To report a bug, please open a new issue on the GitHub repository. Be sure to include:

  1. A clear and descriptive title.
  2. A detailed description of the bug, including steps to reproduce it.
  3. Any relevant screenshots or error messages.
  4. Your operating system, and any other relevant system information.

Suggesting Enhancements

To suggest a new feature or enhancement, please open a new issue on the GitHub repository. Be sure to include:

  1. A clear and descriptive title.
  2. A detailed description of the proposed feature or enhancement.
  3. Any relevant examples or use cases.
  4. Any potential drawbacks or challenges.

Community

To get in touch with the UpdateGuardian community, join our Gitter chatroom, mailing list, or other communication channels.

Once again, thank you for considering to contribute to UpdateGuardian! Your efforts will help make this project better for everyone.