Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 4.2 KB

CONTRIBUTING.md

File metadata and controls

73 lines (50 loc) · 4.2 KB
Raw

Contributing to Meal Maestro

First of all, thank you for your interest in contributing to our project! Your help will make our application even better.

How to Contribute

1. Set up the Environment:

  • Fork the repository to your GitHub account.
  • Clone the forked repo to your local machine: git clone https://github.com/COS301-SE-2023/Meal-Maestro.git
  • Set up the necessary dependencies and environment as per the instructions provided in our installation manual which can be found here.

2. Find an Issue

  • Browse through the open issues.
  • If there's a particular issue you'd like to work on, comment on it to let maintainers know.
  • If there's a feature or a bug not listed in the issues, create a new one and describe it.

3. Start Coding!

  • We follow the GitFlow Strategy for branching.
  • Create a new branch for your feature or bugfix: git checkout -b
  • Make the necessary changes and commit them with meaningful commit messages.
  • Push your changes to your forked repo.

4. Create a Pull Request (PR)

  • Go to the original repository on GitHub.
  • Click on the "New Pull Request" button.
  • Select the branch from your fork and create a pull request.
  • Make sure to provide a brief description of the changes you made and reference any issues it addresses.

Ways to Contribute

  1. Improve Algorithms: Enhance the existing algorithms for better meal suggestions or integrate new algorithms.

  2. Database Integration: Add support for more databases or improve the current database schema.

  3. User Interface: Design or refine the UI/UX of the application.

  4. Dietary Database Expansion: Add new dietary requirements or improve the accuracy of the current ones.

  5. Tests: Write unit or integration tests to improve the software's reliability.

  6. Documentation: Create tutorials, FAQs, or improve the existing documentation.

  7. Research: Conduct studies on user behavior, dietary trends, or anything that could make the app more efficient.

  8. Localization: Translate the application to support multiple languages.

Code of Conduct

Purpose

The Meal Maestro team is dedicated to providing a harassment-free experience for everyone, regardless of gender, gender identity and expression, age, sexual orientation, disability, physical appearance, body size, race, ethnicity, or religion. We do not tolerate harassment of participants in any form. This Code of Conduct outlines our expectations for participant behaviour, as well as the consequences for unacceptable behavior.

Expected Behaviour

  • Be Respectful: Different people have different perspectives and boundaries. Respect differences of opinion and always seek to understand before disagreeing or debating.
  • Be inclusive: Actively seek to include those who may have been left out due to historic exclusion.
  • Be patient: Remember that everyone here is here to learn and grow. Give them the space to do so.

Unacceptable Behaviour

Unacceptable behaviours include: intimidating, harassing, abusive, discriminatory, derogatory or demeaning speech or actions by any participant. This includes, but it not limited to:

  • Written or verbal comments which have the effect of excluding people on the basis of membership of a specific group.
  • Written or verbal comments that cause harm to an individual, especially if they're persistent.
  • Sustained disruption of discussion.
  • Sexual attention or advances of any kind.
  • Advocating for, or encouraging, any of the above behaviour.

Consequences of Unacceptable Behaviour

Unacceptable behaviour from any community member will not be tolerated. Anyone asked to stop unacceptable behaviour is expected to comply immediately. If a community member engages in unacceptable behaviour, they may be temporarily banned or permanently expelled from the community without warning.

Reporting Guidelines

If you are the subject of, or witness to any violations of this Code of Conduct, please contact us by email. All reports will be treated as confidential.