a | b/CONTRIBUTION.md | ||
---|---|---|---|
1 | # Contributing to CfUnit |
||
2 | We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: |
||
3 | |||
4 | Reporting a bug |
||
5 | Discussing the current state of the code |
||
6 | Submitting a fix |
||
7 | Proposing new features |
||
8 | Becoming a maintainer |
||
9 | |||
10 | ## We Develop with CODESYS Forge |
||
11 | We use CODESYS Forge to host code, to track issues & feature requests. |
||
12 | Since CODESYS IDE is currently only using SVN, Pull Requests (PR's) are a bit of an issue currently. |
||
13 | |||
14 | Every code should be checked before submission: |
||
15 | |||
16 | - Does your code have a test in the verifier? |
||
17 | - No => write a test for the verifier |
||
18 | - Yes => provide proof that your code and test works |
||
19 | - After peer review and a working unittest in the verifier is provided, the code is eligible for merge in the trunk. |
||
20 | |||
21 | ## Any contributions you make will be under the MIT Software License |
||
22 | In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. |
||
23 | Feel free to contact the maintainers if that's a concern. |
||
24 | |||
25 | ## Report bugs using Codeys Forge [Tickets] |
||
26 | We use Tickets to track public bugs. Report a bug by [opening a new ticket](https://forge.codesys.com/prj/cfunit/tickets/new); it's that easy! |
||
27 | |||
28 | ## Write bug reports with detail, background, and sample code |
||
29 | |||
30 | **Great Bug Reports** tend to have: |
||
31 | |||
32 | - A quick summary and/or background |
||
33 | - Steps to reproduce |
||
34 | - Be specific! |
||
35 | - Give sample code if you can. |
||
36 | - What you expected would happen |
||
37 | - What actually happens |
||
38 | - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) |
||
39 | |||
40 | ## Use a Consistent Coding Style |
||
41 | * Never open/edit the trunk code! Instead, create a (local) branch under your own name and make your code adjustmensts there. |
||
42 | * Make sure to keep the library settings and project information as the trunk project, except your version number. |
||
43 | * Make sure that your CODESYS IDE uses spaces instead of tabs. The default behaviour of the CODESYS IDE is to use tabs so it needs to be changed. See Tools - Options - Text Editor - Editing - Untick "Keep tabs" and set tabwidth to 4 |
||
44 | |||
45 | ## License |
||
46 | By contributing, you agree that your contributions will be licensed under its MIT License. |
||
47 | |||
48 | ## References |
||
49 | This document was adapted from briandk's excellent [contribution guidelines template](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62). |