search

porthorian / overengineered-eats

MIT License
3 stars 1 forks source link

readme

Adventures of the Complicated Food List

Welcome to the repository documenting the adventures of the complicated food list for individuals in our corporation. In this project, we aim to maintain a comprehensive and dynamic food list that caters to the diverse dietary preferences and restrictions of our employees. This readme will guide you through the process of contributing to this essential resource.

Table of Contents

Introduction

In a diverse corporate environment, it's essential to consider the dietary needs of our employees when planning events, meetings, and gatherings that involve food. This project aims to create a complicated food list that covers a wide range of dietary preferences and restrictions, including but not limited to vegetarian, vegan, gluten-free, lactose-intolerant, and religious dietary requirements. By maintaining this comprehensive list, we can ensure that everyone feels included and valued during food-related events.

Goals

The primary goals of this project are as follows:

  1. Comprehensive Food List: Create and maintain a detailed food list that covers various dietary preferences and restrictions.
  2. Easy Navigation: Organize the food list in a way that makes it easy for users to find suitable options quickly.
  3. Crowdsourced Knowledge: Encourage contributions from employees to keep the list up-to-date and relevant.
  4. Continuous Improvement: Regularly review and improve the list based on feedback and changing dietary preferences.

How to Contribute

We welcome contributions from all employees who have suggestions to improve our complicated food list. To contribute, follow these steps:

Step 1: Fork the Repository

Click on the "Fork" button at the top right corner of this repository to create your copy.

Step 2: Set Up the Project Locally

Clone your forked repository to your local machine using the following command:

git clone https://github.com/Porthorian/overengineered-eats.git

Step 3: Create a New branch

Create a new branch to work on your contribution:

git checkout -b {your-initials}/add-new-food-items

Step 4: Make Changes

Now, it's time to add your contributions to the food list. Open the persons food list {name}.md file and add new items following the established format:

Step 5: Commit Changes

After making the necessary changes, commit them using the Angular commit message format:

git add {name}.md
git commit -m "feat(food-list): Add new vegetarian and gluten-free food items"

Step 6: Push Changes

Push your changes to your forked repository:

git push origin {name-initials}/add-new-food-items

Step 7: Create a Pull Request

Go to the original repository on GitHub and click on the "Pull Request" button. Fill in the necessary details about your contribution, and submit the pull request.

Code of Conduct

Please note that all contributions to this project are governed by our Code of Conduct. Be respectful and considerate of others while participating in this project.

License

This project is licensed under the MIT License. By contributing to this project, you agree to make your contributions available under this license.

Thank you for your interest in improving the complicated food list for our corporation! Together, we can create a more inclusive and accommodating environment for everyone. Happy contributing!