Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (30 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

48 lines (30 loc) · 2.47 KB

Contributing to commander-pkg-meta

First off, thank you for considering contributing. Your help is greatly appreciated!

This document provides a set of guidelines for contributing to this project. These are mostly guidelines, not strict rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

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. Please report unacceptable behavior.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Check the existing issues to see if the bug has already been reported.
  • If you can't 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

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.

  • Provide a clear and detailed explanation of the enhancement you are proposing.
  • Explain why this enhancement would be useful.
  • Provide a code sample or screenshots if they help illustrate the concept.

Your First Code Contribution

Ready to contribute? Here's how to set up for a pull request.

  1. Fork the repository and create your branch from main.
  2. Clone your fork locally: git clone https://github.com/your_username/commander-pkg-meta.git
  3. Create a new branch for your changes: git checkout -b feature/your-amazing-feature
  4. Make your changes in the new branch.
  5. Commit your changes with a descriptive commit message: git commit -m 'feat: Add some amazing feature'
  6. Push your branch to your fork: git push origin feature/your-amazing-feature
  7. Open a pull request to the main branch of the original repository.

Styleguides

Please try to follow the coding style of the project. We use a linter to enforce a consistent style.

  • Run npm install to install the development dependencies.
  • Run npm run lint before committing to ensure your code adheres to the style guide.

Thank you for your contribution!