Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

52 lines (38 loc) · 2.09 KB

Contributing to Alimento

Thank you for considering contributing to Alimento! We appreciate your help in making our project better. Here are some guidelines to help you get started.

How to Contribute

There are several ways to contribute to this project:

  1. Reporting Issues: If you find a bug or have a feature request, please open an issue in the GitHub Issues section. Make sure to provide as much detail as possible.

  2. Submitting Code:

    • Fork the Repository: Click the "Fork" button at the top right of the repository page to create your own copy of the repository.
    • Clone Your Fork: Clone your fork to your local machine:
      git clone https://github.com/vimall03/Alimento.git
    • Create a Branch: Create a new branch for your changes:
      git checkout -b my-feature-branch
    • Make Changes: Implement your changes and make sure to follow the code style used in the project.
    • Commit Your Changes: Add and commit your changes:
      git add .
      git commit -m "Description of your changes"
    • Push Your Changes: Push your changes to your fork:
      git push origin my-feature-branch
    • Open a Pull Request: Go to the original repository and click on "New Pull Request." Select your branch and submit your pull request.

Code Style Guidelines

Please ensure your code adheres to the following guidelines:

  • Use clear and descriptive names for variables and functions.
  • Write comments to explain complex logic.
  • Follow the existing code style for consistency.

Testing

Before submitting your changes, make sure to test your code. Run the existing tests and add new ones if you introduce new features.

Code of Conduct

Please review and adhere to our Code of Conduct while contributing.

Questions?

If you have any questions or need help, feel free to reach out to us by opening an issue or contacting us directly.

Thank you for contributing to Alimento!