Skip to content

Latest commit

 

History

History
50 lines (30 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

50 lines (30 loc) · 2.7 KB
Raw

Contributing to the Mess Management System

We welcome contributions to the Mess Management System (MMS) - a project aimed at streamlining the mess management processes at IIIT Guwahati. This document provides guidelines for contributing to the MMS project.

Team Contributions

Each member of our team has brought unique skills and focus areas to this project:

  • Aman Verma has been instrumental in implementing user authentication, registration, and role management functionalities, ensuring a secure and smooth user experience.
  • Abhishek Kumar has contributed significantly to the complaint management system, from the filing of complaints to their assignment and tracking.
  • Aman Soni has played a vital role in menu data management, from creation to real-time updates, ensuring that meal offerings are up-to-date and accurately represented.

Detailed descriptions of each member’s contributions can be found in the document/contributions directory.

How to Contribute

If you are interested in contributing to the MMS project, please follow these steps:

  1. Familiarize Yourself with the Project: Read through the documentation, especially the README.md and INSTALL.md to understand the project's setup and features.

  2. Check the Issues: Look through the open issues for tasks that need assistance. If you have a suggestion or have identified a bug, open a new issue.

  3. Feature Branches: If you're adding a new feature or fixing a bug, please create a new branch from main for your work.

  4. Coding Standards: Adhere to the coding standards and best practices established in the project. Include comments and documentation as needed.

  5. Submit a Pull Request: Once your feature or fix is ready, submit a pull request (PR) against the main branch. Provide a clear description of the changes and reference any relevant issues.

  6. Code Review: Await review from the project maintainers. Be open to feedback and make any requested changes to your PR.

  7. Approval & Merge: Once your PR is approved by a maintainer, it will be merged into the main branch.

Code of Conduct

All contributors are expected to adhere to the project's code of conduct. This includes respecting fellow contributors, maintaining a professional environment, and working collaboratively.

Recognition

Contributors who provide significant improvements or additions to the project will be recognized for their work in the project’s documentation.

Thank you for your interest in contributing to the Mess Management System. Your efforts help us to improve and evolve this project to meet the needs of its users.

For any questions or further guidance, please reach out to the project maintainers.