Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

52 lines (31 loc) · 2.17 KB

Contributing to Glider Flight Planner

First off, thank you for considering contributing to Glider Flight Planner! It's people like you that make this project a great tool for glider pilots. This document provides guidelines for contributing to the project.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please read it before contributing.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with your suggestion. Be sure to include a title and clear description, as much relevant information as possible, and consider providing relevant context like the benefits and challenges of the enhancement.

Pull Requests

  1. Fork the repository and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

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.

Python Styleguide

Adhere to the PEP 8 style guide.

HTML/CSS Styleguide

  • Use soft tabs (2 spaces) for indentation.
  • Prefer classes over IDs for styling elements.
  • Avoid using inline styles.

Additional Notes

Remember, contributions to this project should aim to benefit all users and not just a specific subset. Be considerate and respectful of all contributors and users.

Thank you for contributing!