Skip to content

Latest commit

 

History

History
97 lines (71 loc) · 4.21 KB

CONTRIBUTING.md

File metadata and controls

97 lines (71 loc) · 4.21 KB
Raw

Contributing to [Project Name]

Thank you for considering contributing to Meal Match! This document provides guidelines to help you get involved.

Table of Contents

  1. How to File a Bug Report
  2. How to Suggest a New Feature
  3. How to Submit a Pull Request
  4. Setting Up Your Environment
  5. Running Tests
  6. Types of Contributions We're Looking For
  7. Getting Started for Newcomers
  8. Technical Requirements
  9. High-Level Design and Architecture
  10. Project Ground Rules
  11. Getting in Touch

How to File a Bug Report

If you find a bug, please help us improve the project by filing a bug report:

  • Check the existing issues to ensure it hasn't been reported yet.
  • Include a clear and descriptive title.
  • Provide as much detail as possible about the issue, including steps to reproduce, expected behavior, and screenshots if applicable.
  • Label the issue as a bug.

How to Suggest a New Feature

We welcome suggestions for new features:

  • Start by checking the existing issues to see if your idea has already been suggested.
  • Open a new issue with the enhancement label.
  • Clearly describe the feature, including why it would be useful and any implementation ideas you may have.

How to Submit a Pull Request

To contribute code:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix: git checkout -b feature/your-feature-name.
  3. Make your changes, ensuring you follow the project's coding style.
  4. Write tests to cover any new code.
  5. Commit your changes: git commit -m "Add your descriptive message here".
  6. Push to your branch: git push origin feature/your-feature-name.
  7. Submit a pull request to the main branch.

Pull Request Process

  • Your PR will be reviewed by another group member.
  • Feedback may be provided, and you might be asked to make changes.
  • Once approved, your PR will be merged. If additional work is needed, we’ll guide you through it.

Running Tests

To ensure the quality of your contributions:

  1. Run the test suite with npm test.
  2. Make sure all tests pass before submitting your pull request.
  3. Add new tests for any code you write to ensure future stability.

Types of Contributions We're Looking For

We appreciate various contributions, including but not limited to:

  • Bug fixes
  • New features
  • Documentation improvements
  • Code refactoring
  • Test coverage

Please avoid:

  • Submitting untested code.
  • Large, unscoped changes without discussion.
  • Changes that break existing functionality.

Getting Started for Newcomers

If you're new to the project, look for issues labeled with good first issue. These are suitable for newcomers and provide a great way to start contributing.

Technical Requirements

Please ensure that your contributions adhere to the following:

High-Level Design and Architecture

For an overview of the project's design and architecture, please refer to the project proposal. This will give you context on how the different parts of the project fit together.

Project Ground Rules

We expect contributors to adhere to the Code of Conduct. This includes:

  • Respectful and inclusive behavior.
  • Constructive feedback.
  • Collaboration over competition.

Getting in Touch

If you have any questions, feel free to open an issue or reach out via email ([email protected]) for general inquiries.

Thank you for contributing to Meal Match!