Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GoldenGnu authored Oct 6, 2024
1 parent c64eda0 commit ccf210e
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
We usually work in two branches:
* New Features:
https://github.com/GoldenGnu/jeveassets/tree/develop
* Bug Fixes:
* Bug Fixes:
https://github.com/GoldenGnu/jeveassets/tree/main

Bug fixes are committed to both branches.
Experimental features get their own branch.
The feature branch is merged back into trunk after release.
Bug fixes are committed to both branches.
Experimental features get their own branch.
The develop branch is merged back into trunk after release.

# Git Clone #

Expand All @@ -22,24 +22,22 @@ We compile with the latest version of Oracle Java SE 8 (Yes, still using Java 8)

Open the project and compile (F11)

## Eclipse ##
## Other IDEs ##

I do not use Eclipse. If you have instructions to compile with Eclipse, please email [email protected]
I only use NetBeans. Feel free to make a PR with instructions

# Coding Guidelines #

* We use tab and not space. Be sure to disable "expand tabs to space" in your IDE.
* Swing JComponent variable names should have leading "j". Ex.: jMyTable
* Swing JComponent variable names should have leading "j". Ex.: `jMyTable`
* No other variable names should use [Systems Hungarian](https://en.wikipedia.org/wiki/Hungarian_notation)

# Contribute #

We are looking for (in random order):
* Documentation (User tutorials)
* Documentation
* Java Programmers
* Dedicated Testers
* Translators

If you want to join the project send an email the [email protected]

Also join the [Discord](https://discord.gg/8kYZvbM) server.
If you want to join the project contract `goldengnu` on the [jEveAssets Discord server](https://discord.gg/8kYZvbM) (PMs welcome).

0 comments on commit ccf210e

Please sign in to comment.