Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.57 KB

Contributing to bville-recycle ♻️

Thank you for considering contributing to bville-recycle! We welcome contributions to make recycling information accessible to the Bartlesville community. This document outlines how you can contribute.

How to Contribute

Reporting Issues

If you encounter bugs, have feature suggestions, or notice any inaccuracies in the recycling map:

  1. Search the issues page to see if it’s already reported.
  2. If not, create a new issue and provide:
    • A clear and concise description of the issue.
    • Steps to reproduce the problem, if applicable.
    • Any relevant screenshots or logs.

Submitting Code Changes

  1. Fork the Repository
  2. Write Tests
  3. Make changes
  4. Open a Pull Request

Code of Conduct

By contributing, you agree to follow the Code of Conduct.

Development Standards

  • Follow Test-Driven Development (TDD) principles (or at least something reasonably close to TDD).
  • Write clean and maintainable code.
  • Avoid using unsafe Rust features.
  • Adhere to our security policies, including implementing encryption as specified in REQUIREMENTS.md.

License

By contributing to this repository, you agree to have your contributions be licensed under the repository's LICENSE as well.

Need Help?

If you have questions or need assistance, feel free to:

  • Open a discussion.
  • Contact the maintainers through the repository.

Thank you for contributing! 🚀