Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (37 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.44 KB
Raw

Contributing to avdoc 🤝

First off, thank you for considering contributing to avdoc! It's people like you that make avdoc such a great tool for the "vibecoding" community.

🌈 How Can I Contribute?

Reporting Bugs

  • Check the GitHub Issues to see if the bug has already been reported.
  • If not, open a new issue. Be sure to include a clear title, a description of the problem, and steps to reproduce it.

Suggesting Enhancements

  • Open a new issue with the tag enhancement.
  • Describe why this feature would be useful and how you imagine it working.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. Ensure your code follows the existing style (run cargo fmt).
  3. Make sure all tests pass (cargo test).
  4. Link your PR to the relevant issue.

🛠️ Local Development

To get started with the codebase:

  1. Clone the repository:

    git clone https://github.com/Aryan-202/avdoc.git
cd avdoc

  2. Build the project:

    cargo build

  3. Run the CLI:

    cargo run -- --help

📜 Coding Guidelines

  • Keep it simple. avdoc is built for speed and ease of use.
  • Avoid unnecessary dependencies.
  • Ensure the CLI output remains clean and professionally formatted.

⚖️ License

By contributing, you agree that your contributions will be licensed under its MIT License.

Happy coding! 🚀