Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (38 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 1.28 KB
Raw

Contributing to OurGroceries (Node.js)

Thank you for your interest in improving this library. This guide summarizes how to contribute effectively.

Getting Started

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/YOUR_USERNAME/py-our-groceries.git
cd py-our-groceries
  3. Install dependencies: 
    npm install

Making Changes

  1. Implement feature / fix.
  2. Add or update tests in tests/.
  3. Update README.md if user-facing behavior changed.
  4. Add example usage if introducing new endpoints or methods.
  5. Ensure no breaking changes are hidden—document them clearly.

Pull Request Guidelines

Each PR should focus on a single logical change.

Include:

  • Clear description of change & rationale.
  • Any breaking change details (and migration note in README if needed).
  • Test coverage for new logic.
  • Documentation updates.

Code of Conduct

  • Be respectful & inclusive.
  • Assume good intent.
  • Provide constructive, actionable feedback.
  • Help newcomers succeed.

Questions

  • Check README for usage.
  • Search existing issues.

Recognition

Contributors are acknowledged in the project history. Your improvements help everyone—thank you!

License

By contributing you agree your contributions are MIT licensed.