-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
8 additions
and
22 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 |
---|---|---|
@@ -1,23 +1,9 @@ | ||
# Developer Guide | ||
|
||
This document is aimed towards developers who want to contribute to sodalite. | ||
Please read this document of you are planning on contributing to `sodalite`. | ||
|
||
#### Building the man page | ||
Please add the supplied pre-commit hook: | ||
#### Add git hooks | ||
Please symlink the supplied git hooks: | ||
```bash | ||
bin/hooks/symlink-hooks | ||
make setup-hooks | ||
``` | ||
This will translate the markdown man page to the groff manpage, and stage the resulting file everytime you commit. | ||
|
||
#### Code formatting | ||
The project is auto-formatted with PyCharm (default settings). | ||
|
||
### Release Checklist | ||
##### before | ||
- update changelog | ||
- update VERSION variable in __main__.py | ||
- new Dependencies? Update readme! | ||
- push tag | ||
|
||
##### after | ||
- contact dev(at)heiko-nickerl.com and ask to update the aur packages |
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
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
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
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