duckscript/.github/CONTRIBUTING.md
2020-04-19 17:35:13 +00:00

25 lines
928 B
Markdown
Executable file

# Contribution Guidelines
<!-- markdownlint-disable required-headers -->
## Issues
Found a bug? Got a question? Want some enhancement?<br>
First place to go is the repository issues section, and I'll try to help as much as possible.
## Pull Requests
Fixed a bug or just want to provided additional functionality?<br>
Simply fork this repository, implement your changes and create a pull request.<br>
Few guidelines regarding pull requests:
* This repository is integrated with github actions for continuous integration.<br>
Your pull request build must pass (the build will run automatically).<br>
You can run the following command locally to ensure the build will pass:
````sh
cargo make --no-workspace workspace-ci-flow
````
* There are many automatic unit tests as part of the library which provide full coverage of the functionality.<br>Any fix/enhancement must come with a set of tests to ensure it's working well.