Skip to content

Latest commit

聽

History

History
25 lines (15 loc) 路 1.3 KB

CONTRIBUTING.md

File metadata and controls

25 lines (15 loc) 路 1.3 KB
Raw

Contributing

Reporting Issues

If you have found a bug in doxdox please consider the following when submitting an issue:

  • Search existing GitHub Issues - The bug you are experiencing might have already been reported or even fixed in an unreleased version of doxdox so be sure to review both open and closed issues.
  • Create a reproducible test case - To make it easier for maintainers to validate the issue please include a gist containing files used to reproduce the issue.
  • Include relevant information - Include clear steps to reproduce the issue.

Pull Requests

Before submitting a pull request, be sure that the following requirements are met:

  • Additional tests have been added to validate the changes.
  • Relevant documentation has been added.
  • The build passes.

Code Style

Either use the Prettier plugin in editor or run npm run prettier-check and npm run prettier-fix.

License

By contributing to doxdox you agree that your contributions fall under the same license, The MIT License (MIT).