You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 19, 2023. It is now read-only.
We encourage the reporting of issues and bugs, along with pull requests to help make Nailgun codebase better. The following are some information and guidelines to help you contribute to Nailgun.
4
+
5
+
## Tour of the Codebase
6
+
7
+
This is a high-level overview of how the Nailgun repository is organized.
8
+
9
+
### `nailgun-server/`
10
+
11
+
That is where server side code lives, written in Java. It contains both core code under `src/main` and test code under `src/tests`.
12
+
13
+
### `nailgun-client/`
14
+
15
+
Client part of Nailgun, both C and Python versions in appropriate folders.
16
+
17
+
### `nailgun-examples/`
18
+
19
+
Some simple implementations of a Nail, helpful to understand how to write server-side code. One can also execute one of those nails for debugging or integration testing.
20
+
21
+
### `scripts/`
22
+
23
+
Automation scripts, mostly for continuous integration (i.e. Travis CI).
24
+
25
+
### `tools/`
26
+
27
+
Third-party dependencies used in tooling, like linter or code formatter.
28
+
29
+
## Development Workflow
30
+
31
+
### Building Nailgun
32
+
33
+
As simple as running `mvn clean package`.
34
+
35
+
### Running Tests
36
+
37
+
Unit tests and integration tests are JUnit and they are run by Maven when you say 'mvn package'. To run E2E test, just execute `./scripts/travis_ci.sh`. It will also run `mvn package` first with all unit tests.
38
+
39
+
### Using the IntelliJ IDE
40
+
41
+
Just open project from Nailgun's root folder
42
+
43
+
### Code Style
44
+
45
+
Code is autoformatted with Maven plugin and Google code style is used. Be ready to have some changed files after building the project with Maven, so you may have to amend the change to git.
0 commit comments