Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 2.28 KB

Contributing to Treeview CLI

First off, thank you for considering contributing to Treeview CLI! We welcome any help, whether it's reporting a bug, proposing a new feature, or submitting a pull request.

How Can I Contribute?

Reporting Bugs

If you find a bug, please help us by reporting it.

  • First, check the existing issues to see if someone has already reported it.
  • If not, please create a new bug report.
  • Be sure to include a clear description of the bug, steps to reproduce it, and what you expected to happen.

Suggesting Enhancements

We are open to new ideas and features!

  • Please check the existing issues to see if your idea has already been suggested.
  • If it's a new idea, please submit a feature request.
  • Explain why this feature would be useful and how you imagine it could be implemented.

Submitting Pull Requests

If you want to contribute code, you can submit a Pull Request (PR).

  1. Fork the repository on GitHub.

  2. Clone your fork to your local machine.

  3. Create a new branch for your changes.

  4. Make your changes. Please try to follow the existing code style.

  5. Test your changes. Before submitting, ensure all tests pass. You can run the test suite with:

    npm install
npm test

    If you add a new feature, please add or update tests for it.

  6. Commit your changes with a clear and descriptive message.

  7. Push your branch to your fork on GitHub.

  8. Open a Pull Request to the main branch of the vedpawar2254/treeview repository.

  9. Fill out the PR template. Describe what your PR does and why, and reference any related issues.

PR Checklist

Before submitting your PR, please make sure you have:

  • Followed the project's code style.
  • Self-reviewed your changes.
  • Updated documentation if necessary.
  • Added or updated tests to cover your changes.
  • Ensured all existing tests pass.

License

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