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
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+61-3
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,36 @@ These guidelines should be reviewed before contributing to the JTerm project.
6
6
## About
7
7
JTerm is a cross-platform terminal. The project is written in Java so that it can be run on virtually any computer. This document provides information such as project resources, guidelines, and other information needed to start programming for JTerm.
8
8
9
+
## Implementation
10
+
This project is written in Java using [Eclipse IDE for Java EE](http://www.eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/neon3).
11
+
9
12
## Code of Conduct
10
13
The Code of Conduct for any contributions and posting information can be found [here](/CODE_OF_CONDUCT.md).
11
14
15
+
## GitHub Branch
16
+
The development branch of the JTerm project is the `dev` branch. _**Make sure to work off of this branch, not the master!**_ All commits on the dev branch are tracked in the 'Dev' PR. This is the PR that is merged into master.
17
+
18
+
## Builds
19
+
Once you build a file from the source code to an archive (.jar), push it to the /build/jar folder, along with the associated changelog (see Changelog section), source code (see Source Code section), and documentation (see Documentation section.)
20
+
21
+
The format of the archive's filename is as follows: "jterm-v(build version).jar"
22
+
23
+
## Source Code
24
+
Keep all updated and current source code in the /src directory, which should be updated with every build. Please review the [Source Code Style Guide](https://github.com/Sergix/JTerm/blob/master/docs/SourceStyleGuide.md) for more information.
25
+
26
+
Subfolders are formatted for packaging and for CI integration.
27
+
28
+
When pushing the source code with a build, DO NOT change the filenames. As mentioned in the "Builds" section, package the source code with every build into a ".zip" file and a Wrapfile that should be placed in the /build/src directory when pushing a build. Subfolders in the /src directory (e.g. /src/main/java/...) should be included in packaged source. Wrapfiles should only include sources in the `main/` source directory. The format for the file should be as follows: `jterm-src-v(version).zip`, and `jterm-src-v(version).wrap`.
29
+
30
+
## Versioning
31
+
Version numbers should use [Semantic Versioning](https://github.com/mojombo/semver/blob/master/semver.md).
32
+
Numbering versions on files (such as released builds) should take the format of "vX.Y.Z", where "X.Y.Z" is the version.
33
+
34
+
## Documentation
35
+
Documentation is published with every:
36
+
- Major and minor release ([Documentation Style Guide](https://github.com/Sergix/JTerm/blob/master/docs/DocStyleGuide.md))
@@ -18,7 +45,36 @@ Source code, documentation, and patch note styling can be found here:
18
45
Any of these types of files MUST be formatted as shown in these documents.
19
46
20
47
## Changelog
21
-
Any changes, in any branch, MUST be pushed to the changelog file found on the dev branch called "changelog.txt". View the "Changelog" section in the [README](/README.md) for more information. Do not push updates to changelog files on other branches; the dev one is to be the only one changed and updated.
48
+
Every time an update is pushed, the changelog will be updated and pushed as well. It is highly recommended that every time you build you update the changelog.
49
+
50
+
Once you add something to the changelog, DO NOT remove the entry, unless if, and only if, it is incorrect (such as a typo in the version number.) If you change a previous entry you must include a statement stating your change in a seperate entry.
51
+
52
+
The global changelog file is in the root folder of the project and is named "changelog.txt"; EVERY note will go into this file. It is also required that when you push a build you push an associated changelog file, formatted "jterm-changelog-(build version).txt". This file should be pushed to the /build/changelog directory.
53
+
54
+
Changelog entry headings must be formatted as shown in the given example below. New changelog entries in the global "changelog.txt" file should be placed at the _top_ of the file, not the bottom. Simply create a few newlines before the latest entry and use the newlines to enter the new entry information. Entries must also be tab-indented.
55
+
56
+
The format for a changelog entry is as follows:
57
+
```
58
+
(#(entry))[MM/DD/YYYY-HH:MM (version) (username)]
59
+
(entry contents)
60
+
(entry contents)
61
+
(blank newline)
62
+
```
63
+
Here is an example changelog:
64
+
```
65
+
(#2)[2/2/2017-3:33 1.3 NCSGeek]
66
+
information uploaded.
67
+
added files.
68
+
pushed to github.
69
+
70
+
(#1)[1/1/2017-3:33 1.0 Sergix]
71
+
information uploaded.
72
+
pushed to github.
73
+
74
+
```
75
+
Of course, a real changelog would be more descriptive in its entries.
76
+
77
+
Timestamps should be in 24-hour (aka military) time.
22
78
23
79
## Pull Requests
24
80
Pull Requests, of course, MUST be opened on a new branch. The branch and PR name must be short but descriptive of its topic. A description must be made of the PR's purpose and a short description of the added code. Every PR must request to be reviewed by @Sergix or @NCSGeek. Travis CI is also used in this project (dashboard can be found [here](https://travis-ci.org/Sergix/JTerm)), and PR's are automatically checked by Travis CI to make sure they are ready to be deployed.
@@ -34,5 +90,7 @@ If a new bug or issue is found, create a new Issue! The issue name must be short
34
90
- Version of JTerm
35
91
3. "Files and Code" - If you find where the issue is or believe it to be, put the filenames and/or code in this section.
36
92
37
-
## Source Code
38
-
When contributing new source code, edit the files contained in the `/src/main/java/jterm` directory. Create new files as shown in the [Source Code Style Guide](https://github.com/Sergix/JTerm/blob/master/docs/DocStyleGuide.md). The editor used can be any of your choosing, but we recommend [Eclipse](http://www.eclipse.org/). Do not create new directories unless required and given permission by @Sergix or @NCSGeek.
93
+
> JTerm 0.4.0
94
+
> `jterm-v0.4.0.jar`
95
+
> This project and its source are held under the GNU General Public License, located in the LICENSE file in the project's directory.
This project is written in Java using [Eclipse IDE for Java EE](http://www.eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/neon3).
8
+
## Why will it help me?
9
+
Because the JTerm project is written in Java, this provides it various advantages:
10
+
- System compatibility downsides don't exist!
11
+
- Much safer than C++/C and other system languages
10
12
11
-
## Contributing
12
-
View the [Contributing Guidelines](https://github.com/Sergix/JTerm/blob/master/CONTRIBUTING.md) for more information. The JTerm project is open to anyone and any code!
13
-
14
-
## Builds
15
-
Once you build a file from the source code to an archive (.jar), push it to the /build/jar folder, along with the associated changelog (see Changelog section), source code (see Source Code section), and documentation (see Documentation section.)
16
-
The format of the archive's filename is as follows: "jterm-v(build version).jar"
17
-
18
-
## Source Code
19
-
Keep all updated and current source code in the /src directory, which should be updated with every build.
20
-
Please review the [Source Code Style Guide](https://github.com/Sergix/JTerm/blob/master/docs/SourceStyleGuide.md) for more information.
21
-
Subfolders are formatted for packaging and for CI integration.
22
-
When pushing the source code with a build, DO NOT change the filenames.
23
-
As mentioned in the "Builds" section, package the source code with every build into a ".zip" file and a Wrapfile that should be placed in the /build/src directory when pushing a build. Subfolders in the /src directory (e.g. /src/main/java/...) should be included in packaged source. Wrapfiles should only include sources in the `main/` source directory.
24
-
The format for the file should be as follows: `jterm-src-v(version).zip`, and `jterm-src-v(version).wrap`.
25
-
26
-
## Changelog
27
-
Every time an update is pushed, the changelog will be updated and pushed as well.
28
-
It is highly recommended that every time you build you update the changelog. Once you add something to the changelog, DO NOT remove the entry, unless if, and only if, it is incorrect (such as a typo in the version number.) If you change a previous entry you must include a statement stating your change in a seperate entry.
29
-
The global changelog file is in the root folder of the project and is named "changelog.txt"; EVERY note will go into this file. It is also required that when you push a build you push an associated changelog file, formatted "jterm-changelog-(build version).txt". This file should be pushed to the /build/changelog directory.
30
-
Changelog entry headings must be formatted as shown in the given example below.
31
-
New changelog entries in the global "changelog.txt" file should be placed at the _top_ of the file, not the bottom. Simply create a few newlines before the latest entry and use the newlines to enter the new entry information. Entries must also be tab-indented.
32
-
The format for a changelog entry is as follows:
33
-
```
34
-
(#(entry))[MM/DD/YYYY-HH:MM (version) (username)]
35
-
(entry contents)
36
-
(entry contents)
37
-
(blank newline)
38
-
```
39
-
Here is an example changelog:
40
-
```
41
-
(#2)[2/2/2017-3:33 1.3 NCSGeek]
42
-
information uploaded.
43
-
added files.
44
-
pushed to github.
13
+
Plus, it's open source, so if you find any issues, you can help out everyone else using JTerm!
45
14
46
-
(#1)[1/1/2017-3:33 1.0 Sergix]
47
-
information uploaded.
48
-
pushed to github.
15
+
## Where do I get it?
16
+
Check the [releases](https://github.com/Sergix/JTerm/releases) page for binaries, as well as the source code. You can also look in the `/builds` directory for changelogs and other build-related stuff.
49
17
50
-
```
51
-
Of course, a real changelog would be more descriptive in its entries.
52
-
53
-
Timestamps should be in 24-hour (aka military) time.
54
-
55
-
## Versioning
56
-
Version numbers should use [Semantic Versioning](https://github.com/mojombo/semver/blob/master/semver.md).
57
-
Numbering versions on files (such as released builds) should take the format of "vX.Y.Z", where "X.Y.Z" is the version.
58
-
59
-
## Documentation
60
-
Documentation is published with every:
61
-
- Major and minor release ([Documentation Style Guide](https://github.com/Sergix/JTerm/blob/master/docs/DocStyleGuide.md))
View the [Contributing Guidelines](https://github.com/Sergix/JTerm/blob/master/CONTRIBUTING.md) for more information. The JTerm project is open to anyone and any code!
63
20
64
21
## Slack
65
-
The JTerm project now has a Slack messaging group! Request to join the [Sergix](https://sergix.slack.com/) team to recieve notifications on updates, Travis CI build status, and more on the #jterm channel.
22
+
The JTerm project now has a Slack messaging group! Request to join the [Sergix](https://sergix.slack.com/) team to recieve notifications on updates, Travis CI build status, and more!
0 commit comments