Skip to content

Latest commit

 

History

History
119 lines (76 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

119 lines (76 loc) · 3.56 KB
Raw

Contributing Guidelines for Flavour Fusion

Thank you for considering contributing to Flavour Fusion! Your help is greatly appreciated, and your contributions are essential to the success of this open-source project.

Table of Contents

  1. Getting Started

  2. Making Changes

  3. Submitting Your Contribution

  4. Staying Active

  5. Code of Conduct

  6. License

Getting Started

Fork the Repository

  1. Click the "Fork" button at the top-right of the Flavour Fusion repository.
  2. This will create a copy of the repository in your GitHub account.

Clone Your Fork

Clone your fork to your local machine using Git.

git clone url_of_repo

Install Dependencies

Ensure that you have the necessary dependencies installed:

  • HTML, CSS, JavaScript
  • Bootstrap
  • Git and GitHub knowledge

Making Changes

  • Create a new branch for your feature or bug fix. Use a descriptive name that reflects the changes you are making.
  • Write clean, well-documented code.
  • Make sure your changes follow the project's code style.

Code Style

  • Follow the existing coding style used in the project.
  • Ensure code is well-indented and readable.

Testing

  • Test your changes thoroughly and make sure they do not introduce new issues.
  • Write unit tests if applicable.

Submitting Your Contribution

Create a Pull Request

  1. Push your changes to your fork on GitHub.
  2. Visit the Flavour Fusion repository on GitHub.
  3. Click on the "New Pull Request" button.
  4. Select the required branch (depends on issue you resolve) and your feature branch.
  5. Provide a clear and concise title and description of your changes.

PR Template

Please use the following template when creating a Pull Request:

**Description**
A brief description of the changes made.

**Issue**
Closes #IssueNumber (if applicable)

**Related PRs**
Links to related PRs or issues.

**Screenshots or GIFs (if applicable)**
Attach relevant media to illustrate your changes.

**Checklist**
- [ ] Code is well-documented
- [ ] Code follows the project's code style
- [ ] Tests have been added or updated

Staying Active

Comments and Discussions

Stay active in the comments section of the repository to discuss issues, pull requests, and other related matters. Engage in constructive discussions and provide assistance where needed.

Reporting Issues

If you encounter a bug or have a feature request, please open an issue on the issue tracker. Provide a clear and detailed description of the problem or request.

Code of Conduct

Please review and adhere to our Code of Conduct to maintain a respectful and welcoming environment for all contributors.

License

By contributing to Flavour Fusion, you agree that your contributions will be licensed under the project's MIT License.

We appreciate your contributions and look forward to collaborating with you on Flavour Fusion!