Skip to content

contributing.md

Latest commit

 

History

History
49 lines (33 loc) · 2.11 KB

contributing.md

File metadata and controls

49 lines (33 loc) · 2.11 KB

Contributing to VOXRAD

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to VOXRAD. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

If you find a bug in the project, you can help by submitting an issue to the GitHub Issue Tracker. Please include the following details:

  • A clear and descriptive title for the issue.
  • A description of the steps to reproduce the issue.
  • The expected and actual results.
  • Any relevant screenshots or code snippets.

Suggesting Enhancements

If you have an idea for an enhancement, you can help by submitting an issue to the GitHub Issue Tracker. Please include the following details:

  • A clear and descriptive title for the enhancement.
  • A detailed description of the enhancement and why it would be useful.
  • Any relevant examples or mockups.

Pull Requests

If you want to make changes to the codebase, follow these steps:

  1. Fork the repository.
  2. Create a new branch from the main branch.
  3. Make your changes.
  4. Test your changes to ensure they work as expected.
  5. Commit your changes with a clear and descriptive commit message.
  6. Push your changes to your forked repository.
  7. Create a pull request to the main branch of the original repository.

Coding Standards

  • Use consistent coding style.
  • Write clear and concise comments.
  • Ensure your code passes all tests.

Documentation

If you make changes to the codebase, update the documentation to reflect your changes. This includes updating the README.md file and any other relevant documentation files.

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to voxrad@drankush.com.

Thank you for contributing to VOXRAD!