Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.83 KB

Contributing to stdcli

We welcome contributions to stdcli! By participating in this project, you agree to abide by our Code of Conduct.

How to Contribute

We appreciate your help in making stdcli better. Here are some guidelines to follow:

Code of Conduct

Please review our CODE_OF_CONDUCT.md before contributing. We are committed to providing a welcoming and inclusive environment for everyone.

Reporting Bugs

If you find a bug, please open an issue on our GitHub Issues page. When reporting a bug, please include:

  • A clear and concise description of the bug.
  • Steps to reproduce the behavior.
  • Expected behavior.
  • Screenshots or error messages, if applicable.
  • Your operating system and Node.js version.

Suggesting Enhancements

If you have an idea for a new feature or an improvement, please open an issue on our GitHub Issues page. Please include:

  • A clear and concise description of the enhancement.
  • The problem it solves or the benefit it provides.
  • Any relevant examples or mockups.

Pull Request Guidelines

  1. Fork the repository and create your branch from main.
  2. Ensure your code adheres to our coding style and standards (run npm run lint and npm run format).
  3. Write clear, concise commit messages.
  4. If your change adds new functionality, please write appropriate tests.
  5. Ensure all tests pass (npm test).
  6. Update the documentation if necessary.
  7. Submit your pull request to the main branch.

Development Setup

  1. Clone the repository: git clone https://github.com/ioncakephper/stdcli.git
  2. Navigate to the project directory: cd stdcli
  3. Install dependencies: npm install
  4. Run tests: npm test
  5. Run lint: npm run lint
  6. Run format: npm run format