Skip to content

Latest commit

 

History

History
60 lines (34 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

60 lines (34 loc) · 2.82 KB
Raw

Contributing to GreatLakes-TempSensors

👍🎉 First off, thank you so much for considering a contribution to the GreatLakes-TempSensors project! 🎉👍

We strive to create a welcoming and inclusive environment for anyone who wants to participate. These guidelines are meant to provide you with information on how you can contribute and they are meant as a set of guidelines more than strict rules. Please use your best judgment and feel free to propose changes to any documents including this one.

Code of Conduct

Our project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before reporting a bug, please take a look through the issue tracker to see if the issue has already been reported. If not, create a bug report that provides as much detail as possible, such as steps to reproduce, expected outcomes, and actual outcomes.

Suggesting Enhancements

If you have an idea for an improvement or a new feature, please check if it has already been suggested or not in the issue tracker. Your suggestion should include as much detail as possible so that others can understand and consider it.

Pull Requests

Pull requests are a great way to contribute. Here are steps to follow:

  1. Fork the repository and create a new branch from main for your changes.
  2. Make sure your code adheres to the project's standards (described below).
  3. If you've added code that should be tested, add tests.
  4. Ensure your code passes all tests.
  5. Submit your pull request with a detailed description of your changes.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Include the issue or pull request number after the first line.

Python Styleguide

All Python code must adhere to the following style:

  • Code Formatting: The project uses black for code formatting. Use the following command to format your code automatically: (UNDER DEVELOPMENT)
  • Linting: The project uses flake8 to enforce code style. To run flake8, use the following command: (UNDER DEVELOPMENT)

Ensure your code adheres to these styles before submitting a pull request.

Documentation Styleguide

  • Use Markdown for all documentation.
  • Reference code and variables using backticks.

New to Git and GitHub?

If you're unfamiliar with Git or GitHub, we recommend this tutorial offered by Software Carpentry.

License

By contributing, you agree that your contributions will be licensed under the same MIT License as the project.

We can't wait to see what you'll contribute to the project!