From 0f5aa121c09e2f7628cbf98465ea5118ce167a16 Mon Sep 17 00:00:00 2001 From: bloodstalker Date: Thu, 3 May 2018 00:08:40 +0430 Subject: contribution guidelines --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8685117 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +## Contributions + +For a list of available tasks please look at the open issues. I try to keep them up-to-date.
+ +### Code Formatting +For C and C++, please use the clang-format file under `extra-tools`. You can also just skip that and use some common sense.
+For Python, Lua and Haskell, just your common sense. Don't cram your lines into 80 characters. Please don't.
+ +### Write Tests +If you are adding a feature or functionality please also include the tests. all tests go into the test directory under ptoject root inside a folder with the same name as the executable they belong to.
+The travis build is enabled for mutator forks so you can check your pull request's coverage and see whether you have decreased the coverage or not.
+ +### Issues +For discussions regarding the implementations or feature requests or enhancements please use the repo's issues.
+ +### Labels +We have quite a varied range of labels for issues. please use them.
+ +### Contributers.md +Don't forget to add your name to the `Contributers.md` file in the repo root. The list has a chronological order. Don't break that.
-- cgit v1.2.3