Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (56 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

82 lines (56 loc) · 2.58 KB
Raw

Contributing to Apso CLI

We love your input! We want to make contributing to the Apso CLI as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with GitHub

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using GitHub's issue tracker

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Development Process

  1. Clone the repository
  2. Create a new branch for your feature/fix
  3. Install dependencies: npm install
  4. Make your changes
  5. Build: npm run build
  6. Run tests: npm test
  7. Run linting: npm run lint
  8. Submit a pull request

Commit Messages

We follow the Conventional Commits specification.

Example commit messages:

  • feat(scaffold): add support for new field type
  • fix(template): resolve enum generation issue
  • docs(readme): update installation instructions

Code Style

  • We use ESLint and Prettier for code formatting
  • Follow the existing code style
  • Use meaningful variable and function names
  • Add comments for complex logic

Testing

  • Write unit tests for new features
  • Update existing tests when modifying features
  • Use meaningful test descriptions

License

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