-
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: tison <[email protected]>
- Loading branch information
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |