Skip to content

Latest commit

 

History

History
78 lines (54 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

78 lines (54 loc) · 2.7 KB
Raw

Contributing to VisiUI Docs

First of all, thank you for taking the time to contribute! 🎉 The following is a set of guidelines for contributing to this project on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Styleguides
  4. Pull Requests
  5. License

Code of Conduct

This project follows the Contributor Covenant Code of Conduct.

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening an issue. Before submitting, check if the issue has already been reported.

To help us address the issue, please include:

  • A clear and descriptive title.
  • Steps to reproduce the bug.
  • Information about your environment (OS, browser, etc.).
  • Any relevant error messages or logs.

Suggesting Enhancements

Have an idea to improve the project? We'd love to hear about it!

To suggest an enhancement:

  • Open an issue with a clear title and detailed description of the suggestion.
  • Explain why this enhancement would be useful.
  • Provide examples or mockups if applicable.

Contributing Code

We welcome contributions of code! Here's how to get started:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/my-feature).
  3. Make your changes, including tests if necessary.
  4. Commit your changes (git commit -am 'Add new feature').
  5. Push to your fork (git push origin feature/my-feature).
  6. Open a pull request and describe the changes you’ve made.

Styleguides

Git Commit Messages

  • Use present tense ("Add feature" not "Added feature").
  • Use imperative mood ("Fix bug" not "Fixed bug").
  • Keep the first line under 50 characters.

Code Style

  • Follow the existing code style in the repository.
  • Write clear and descriptive comments.
  • Include tests for new features or bug fixes.

Documentation

If your contribution affects the functionality or interface, ensure the documentation is updated.

Pull Requests

When submitting a pull request:

  • Ensure that the pull request follows the repository's style.
  • Include a detailed description of what the pull request does.
  • Reference any related issues (e.g., "Closes #123").
  • Wait for feedback from project maintainers, and be prepared to make changes.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.