Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.65 KB
Raw

Contributing to structurizr-d2-exporter

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to this project. These are guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Reporting Bugs and Suggesting Enhancements

If you find a bug or have an idea for an enhancement or new feature, create a new issue in the GitHub repository. Be sure to include a clear title and description in the issue.

If you find a vulnerability, follow the guidelines provided in [SECURITY.md].

Code Contributions

Pull requests are the best way to propose changes to the codebase. We 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. Ensure the test suite passes.
  4. Make sure your code lints. Use Kotlin coding conventions.
  5. Issue a pull request.

All code contributions and pull requests should adhere to the Apache 2.0 license.

Commit Messages

Make sure your commit messages are clear and descriptive for what changes are being made. Follow Conventional Commits specification for commit messages. This will make it easier for others to understand your changes.

Code of Conduct

Any contributions should follow the Code of Conduct which aims to foster an open and welcoming environment.