Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ketola authored Jul 14, 2019
1 parent 4c33d73 commit 9ffa1e7
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### You're welcome to join the development of JLibra

## Have a new feature in mind?
Create an Issue about it and describe the feature you have in mind.

## Want to work on an existing issue?
Claim the issue and add a description about how you're planning to solve it.

## Before writing code
Set up the code conventions in your IDE
(If your IDE does not supprort these settings, don't let that hold you, just try to make the code similar to the existing)

### Eclipse
**Code format:** Window -> Preferences -> Java > Code Style > Formatter - Import the file `jlibra-eclipse-code-format.xml` from the project root

**Import ordering:** Window -> Preferences -> Java > Code Style > Organize Imports - Import the file `jlibra-eclipse.importorder` from the project root

After this you can also enable 'Format source code' and 'Organize Imports' from the Save Actions (Java > Editor > Save Actions)

### IntelliJ
TODO

0 comments on commit 9ffa1e7

Please sign in to comment.