Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

43 lines (32 loc) · 1.59 KB
Raw

Contributing to rekon

Thank you for considering contributing to rekon! Your involvement makes this project better.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine: 
    git clone https://github.com/austimkelly/rekon.git
  3. Create a new branch for your contribution: 
    git checkout -b feature/your-feature-name
  4. Make your changes and commit them with clear and concise messages: 
    git commit -m "Add your feature or fix"
  5. Push your changes to your fork: 
    git push origin feature/your-feature-name
  6. Open a pull request in this repository with a clear title and description of your changes.
  7. Your pull request will be reviewed, and once approved, it will be merged.

Style Guidelines

  • Follow PEP 8 for Python code style.
  • Ensure your code is well-documented and includes comments where necessary.
  • Write meaningful commit messages.

Report Bugs

If you find any bugs or issues, please create a new issue with a detailed description of the problem, including steps to reproduce.

Feature Requests

If you have a feature you'd like to see added, feel free to open an issue with your suggestion. We appreciate your input!