Skip to content

Latest commit

 

History

History
68 lines (50 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

68 lines (50 loc) · 3.47 KB

Contributing to MonitorMind

We're excited that you're interested in contributing to MonitorMind! This document outlines the guidelines for contributing to this project. Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open-source project. In return, they will reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Quick Links

Getting Started

  • Fork the repository on GitHub.
  • Clone your forked repository to your local machine.
  • Create a new branch for your changes.

Reporting Bugs

Before creating bug reports, please check the issue tracker as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • 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.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When you are creating an enhancement suggestion, include as many details as possible:

  • 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.
  • Provide specific examples to demonstrate the steps.

Code Contribution

  • Make sure your code adheres to the project's coding conventions.
  • Write good commit messages.
  • Push your changes to a branch in your fork of the repository.
  • Submit a pull request to the main branch of the official repository.
  • Include a clear and descriptive title and body in the pull request.

Pull Requests

The process described here has several goals:

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

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

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

Style Guides

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.

Python Style Guide

  • Follow the PEP 8 style guide.
  • Include comments and docstrings where necessary for code clarity.

Flask Development

Questions?

Don't hesitate to contact the project maintainers if you have any questions, comments, or concerns. See the GitHub page for more information.

Acknowledgements

Your contributions are greatly appreciated and will be duly recognized.