Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 2.23 KB
Raw

Contributing to @mands/nx-plugins

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

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

We develop with GitHub

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

Contribute by making a Pull Request

A pull request is the best way to propose a change 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. Manually update the version property in the root package.json, ensuring you follow semver conventions when choosing the new version
  4. Do the same in the package.json for the package that you have updated in packages
  5. Update the documentation if required
  6. Ensure PR validation passes
  7. Issue the pull request

License

By submitting a code change, you agree that your contribution will be licensed under this project's MIT License. Please contact the maintainers if this is a concern.

Report bugs using GitHub Issues

We use GitHub Issues to track bugs. Report a bug by opening a new issue.

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)

People love thorough bug reports and this helps us to make sure we can address and prioritise bugs as efficiently as possible.

Use a consistent coding style

We enforce a consistent coding style using linting rules. Please ensure that your code adheres to the project's linting rules and avoids lint ignores.

References