Permalink
Browse files

Create CONTRIBUTING.md

  • Loading branch information...
gquerret committed Jan 3, 2018
1 parent 43c6ab0 commit 5c9b2f8b4d2013cd824066f5b5e4f1a3de3532bb
Showing with 30 additions and 0 deletions.
  1. +30 −0 CONTRIBUTING.md
View
@@ -0,0 +1,30 @@
## How to report bugs ?
* Please use the Issues page on GitHub.
* Use the provided templates to report issue
* Always include the version number of PCT and OpenEdge ; you can easily get this information by including the following statements in your build.xml :
```xml
<PCTVersion />
<ProgressVersion dlcHome="${DLC}" fullVersion="dlc.version.full" />
<echo message="${dlc.version.full}" />
```
Which will give you something like:
```
[PCTVersion] PCT Version : jenkins-Dev1-PCT-376
[echo] OpenEdge Release 11.5 as of Fri Dec 5 19:02:15 EST 2014
```
* Upgrade to the latest version of PCT if possible
* Include a verbose log of your problem, by using `ant -v`
* For old versions of PCT, include a verbose log by adding verbose="true" in your PCTRun or PCTCompile statement
* If you have a problem with [[PCTCompileExt]], first verify that [[PCTCompile]] works correctly.
* If you want a problem to be fixed in a short amount of time, include a test case to reproduce the problem. The easier it will be for me to reproduce the problem, the faster the fix will come
* If you know how to fix a problem, please open a pull request
## How to build PCT ?
* Fork and clone project on GitHub
* Modify `pct.build.properties` to match your OpenEdge installation dir
* Make sure you don’t have PCT.jar in `$ANT_HOME/lib`
* Execute `ant jar` to build everything (PCT.jar is created in dist/ directory)
* Execute `ant prepare-test` to (re)generate the testbox dir, where tests are executed
* Execute `ant -file tests.xml` to execute unit tests

0 comments on commit 5c9b2f8

Please sign in to comment.