Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

73 lines (47 loc) · 2.56 KB

Contributing to trendUI

We're thrilled that you're interested in contributing to trendUI! This document provides guidelines and information about how you can contribute to this project. Whether you're reporting a bug, suggesting enhancements, or adding a new feature, every contribution is appreciated.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

How to Contribute

Contributions can be made in various ways:

Reporting Issues

Before reporting an issue, please check if it is already listed in the issues tab. If not, create a new issue and include:

  • A clear title and description.
  • As much relevant information as possible (e.g., steps to reproduce the issue, expected vs. actual behavior).
  • Include screenshots and error messages if possible.

Suggesting Enhancements

We love new ideas! If you have a suggestion for improving trendUI:

  1. Visit the issues tab to see if someone else has already suggested a similar enhancement.
  2. If not already suggested, open a new issue with:
    • A clear title and detailed description of the proposed feature.
    • Explain why this enhancement would be useful to trendUI users.

Pull Requests

Want to submit a pull request? Great! Here’s how:

  1. Fork the repository and create your branch from main.
  2. If you've added code, please ensure it adheres to the existing style.
  3. Ensure your code includes any necessary tests and that all tests pass.
  4. Update the README.md with details of changes if applicable.
  5. Write a clear log message for your commits and pull request:
    • Include the purpose of the change.
    • Describe any significant modifications.
    • Mention which issues are fixed by this (include issue numbers).

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally.

Development Setup

Here’s how you can set up the trendUI for local development:

# Fork the `trendUI` repo on GitHub.
# Clone your fork locally:
git clone [email protected]:trendui/trendUI.git

# Install dependencies:
npm install

# Running Tests
npm test

License

By contributing, you agree that your contributions will be licensed under its MIT License.

Acknowledgments

  • Thank you for contributing to trendUI!