-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #394 from DOV-Vlaanderen/docs-contributions
Add some documentation for the contrib section.
- Loading branch information
Showing
2 changed files
with
38 additions
and
8 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
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,19 @@ | ||
# Contributions | ||
|
||
Welcome to the contribution section of the pydov repository! This section | ||
includes scripts and tools made by contibutors (you!) that might benefit others too. | ||
|
||
## Add yours! | ||
|
||
If you made a script using pydov that you think might also be useful for others, | ||
don't hesitate to open a pull request to add it here! | ||
|
||
The minimum to provide besides the script itself is: | ||
- a README.md containing minimal information on what it does and how to use it | ||
- a requirements.txt if your script requires additional dependencies | ||
|
||
## Disclaimer | ||
|
||
The scripts and tools provided here are not maintained by the pydov core team | ||
and do not require the same level of code quality and test coverage as the | ||
pydov core modules. |