Skip to content

Latest commit

 

History

History
70 lines (60 loc) · 4.5 KB

CONTRIBUTING.md

File metadata and controls

70 lines (60 loc) · 4.5 KB

MilkBasket Contributing Guidelines

Welcome to the MilkBasket repository! We appreciate your interest in contributing to our project. By following these guidelines, you can help us maintain a collaborative and inclusive environment for all contributors. Please take a moment to review this document before making any contributions.

Table of ContentsTable of Contents

  • Code of Conduct
  • How to Contribute
  • Bug Reports
  • Feature Requests
  • Pull Requests
  • Style Guide
  • License

Code of Conduct

Before getting started, please read and adhere to our Code of Conduct. We expect all contributors to follow the code of conduct throughout their involvement in the project.

How to Contribute

Contributions to the project can be made in the form of bug reports, feature requests, and pull requests. We value your input and appreciate the effort you put into making this project better. To contribute, follow the steps below:

  1. Fork the repository to your GitHub account.
  2. Create a new branch from the master branch. The branch name should be descriptive of the contribution you're making.
  3. Make your changes or additions to the codebase.
  4. Write unit tests, if applicable, to cover any new functionality or bug fixes.
  5. Ensure that your code follows our Style Guide.
  6. Commit your changes and provide a clear and concise commit message.
  7. Push your branch to your forked repository.
  8. Submit a pull request to the master branch of the main repository.
  9. Wait for the project maintainers to review your contribution. Be prepared to make necessary changes or address feedback during the review process.

Bug Reports

If you encounter a bug or a problem with the project, please submit a bug report. Follow these steps to report a bug:

  1. Ensure that the bug hasn't been reported already by searching through the existing issues.
  2. If the bug hasn't been reported, open a new issue.
  3. Provide a descriptive title and a clear description of the bug, including steps to reproduce it.
  4. Include any relevant error messages or screenshots.
  5. Label the issue with the appropriate tags, such as "bug" and any relevant priority labels.
  6. Engage in the discussion if more information is needed or requested by project maintainers.

Feature Requests

If you have an idea for a new feature or an enhancement to the project, you can submit a feature request. Here's how:

  1. Search the existing issues to ensure that the feature hasn't been requested before.
  2. If the feature hasn't been requested, open a new issue.
  3. Provide a descriptive title and a clear description of the feature or enhancement.
  4. Explain why the feature would be valuable and how it aligns with the project's goals.
  5. Label the issue with the appropriate tags, such as "feature request" and any relevant priority labels.
  6. Engage in the discussion if more information is needed or requested by project maintainers.

Pull Requests

If you want to contribute code or documentation changes to the project, you can submit a pull request. Follow these steps:

  1. Ensure that there is an open issue discussing the changes you want to make. If not, open a new issue and engage in the discussion before proceeding.
  2. Fork the repository and create a new branch for your changes.
  3. Make your changes in the new branch.
  4. Write clear commit messages and ensure that your code follows our Style Guide.
  5. Include relevant tests to validate your changes, if applicable.
  6. Submit a pull request to the master branch of the main repository.
  7. Provide a concise and descriptive title for your pull request.
  8. Include a summary of the changes and any relevant context in the pull request description.
  9. Be prepared to address any feedback or change requests from project maintainers during the review process.

Style Guide

To maintain consistency and readability within the project, we follow a specific coding style. Please ensure that your contributions adhere to the following guidelines:

  1. Use consistent indentation (spaces/tabs).
  2. Follow the naming conventions used in the project.
  3. Keep code lines reasonably short (around 80 characters).
  4. Comment your code when necessary to enhance clarity.
  5. Write meaningful and descriptive variable and function names.
  6. Follow best practices and conventions specific to the programming language or framework used in the project.

License

By contributing to the project, you agree that your contributions will be licensed under the same license as the project itself. Make sure to review the project's license before making any contributions.