Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

56 lines (32 loc) · 2.75 KB
Raw

Contributing to Base Web

👍🎉 First off, thank you for considering contributing to Base Web! 🎉👍

The following is a set of guidelines for contributing to Base Web. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

  1. Ensure the bug was not already reported by searching on GitHub under Issues.

  2. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  1. Check the Issues to see if there's someone who has already suggested the same enhancement.

  2. If it doesn't exist, create a new issue. Provide a clear and detailed explanation of the feature you want and why it's important to add.

Pull Requests

  1. Fork the repository and create your branch from master.

  2. Make your changes: Apply your changes, following the coding conventions described below.

  3. Commit your changes: Commit your changes using a descriptive commit message.

  4. Open a Pull Request: Describe what you did in the pull request description. Mention the issue number if your pull request is related to an existing issue.

  5. Include Screenshots: If your pull request includes any visual changes to the project, please include before and after screenshots in your pull request description to help us better understand the changes.

  6. Wait for review: Once your pull request is opened, it will be reviewed as soon as possible. Changes may be requested, and your responsiveness is appreciated.

Coding Conventions

  • Use clear and descriptive variable names.
  • Comment your code where necessary.
  • Follow the lint configurations.

Feel free to customize this template according to the specific needs and nuances of Base Web. A well-crafted CONTRIBUTING.md can help your project attract quality contributions and foster a collaborative community.