Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

34 lines (20 loc) · 1.67 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to @nasts/cli! Here are some guidelines to help you get started.

How to Contribute

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Create a new branch with a descriptive name.
  4. Make your changes and commit them with a clear message.
  5. Push your branch to your forked repository.
  6. Submit a pull request to the original repository.

Code Style

We use strict TypeScript and aim to follow a consistent and readable coding style. Please take a look at the existing codebase and try to follow the existing style as closely as possible.

We also use ESLint and Prettier to ensure consistent code formatting. Please run npm run lint before submitting a pull request to check for any linting errors.

Testing

Please make sure any changes you make are thoroughly tested. We use Jest for testing. You can run tests by running npm test in the project directory.

We aim to have a high test coverage, so please make sure that any new code you add is covered by tests. You can check the current test coverage in the output of npm test.

Bug Reports and Feature Requests

If you encounter any bugs or have any feature requests, please open an issue in the GitHub repository.

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. Please make sure to read and follow this code of conduct in all interactions with the project.

Thank you for your contributions!