Skip to content

Commit

Permalink
Create Contribution.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AnujSaha0111 authored Oct 7, 2024
1 parent e8a5709 commit 1a29f58
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions Contribution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# 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](https://github.com/Vimall03/Alimento/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:
```bash
git clone https://github.com/YOUR_USERNAME/Alimento.git
```
- **Create a Branch**: Create a new branch for your changes:
```bash
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:
```bash
git add .
git commit -m "Description of your changes"
```
- **Push Your Changes**: Push your changes to your fork:
```bash
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](CODE_OF_CONDUCT.md) 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!

0 comments on commit 1a29f58

Please sign in to comment.