Skip to content

Commit cbae05d

Browse files
authored
Create CONTRIBUTING.md
1 parent 91e2a59 commit cbae05d

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

CONTRIBUTING.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# SVN Checkout #
2+
3+
We usually work in two branches:
4+
* New Features:
5+
https://github.com/GoldenGnu/jeveassets/branches/feature-branch
6+
* Bug Fixes:
7+
https://github.com/GoldenGnu/jeveassets/trunk/
8+
9+
Bug fixes are committed to both branches.
10+
Experimental features get their own branch.
11+
The feature branch is merged back into trunk after release.
12+
13+
# Git Clone #
14+
15+
https://github.com/GoldenGnu/jeveassets.git
16+
17+
# Compile #
18+
19+
We compile with the latest version of Oracle Java SE 8 (Yes still using Java 8).
20+
21+
## Netbeans ##
22+
23+
Open the project and compile (F11)
24+
25+
## Eclipse ##
26+
27+
I do not use Eclipse. If you have instructions to compile with Eclipse, please email [email protected]
28+
29+
# Coding Guidelines #
30+
31+
* We use tab and not space. Be sure to disable "expand tabs to space" in your IDE.
32+
* Swing JComponent variable names should have leading "j". Ex.: jMyTable
33+
* No other variable names should use Systems Hungarian
34+
35+
# Contribute #
36+
37+
We are looking for (in random order):
38+
* Documentation (User tutorials)
39+
* Java Programmers
40+
* Dedicated Testers
41+
* Translators
42+
43+
If you want to join the project send an email the [email protected]

0 commit comments

Comments
 (0)