Skip to content

Commit

Permalink
docs: Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: tison <[email protected]>
  • Loading branch information
tisonkun authored Jun 10, 2024
1 parent abbb3d3 commit f411b28
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Contributing Guide

Thanks for your help in improving the project!

There are two typical contributions to this project:

1. Add support for new languages. You can refer to https://github.com/korandoru/hawkeye/pull/124 as an example.
2. Add support for new license templates. You can refer to https://github.com/korandoru/hawkeye/pull/148 as an example.

You can find the core concepts with names listed below to understand the design better:

* `DocumentType` defines how a file in a specific type should be handled.
* `HeaderDef` defines the format of a specific header; for example, `SCRIPT_STYLE` will construct the header format for scripts like `.sh` or `.py` files.
* `HeaderStyle` is the serde layer for `HeaderDef`.
* `Selection` describes how to find the files to be handled.
* `HeaderParser` extracts the header slice from a source file.

0 comments on commit f411b28

Please sign in to comment.