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
Hi! Thanks for contributing to the Exercism Java track!
2
+
3
+
Before opening your pull request, please review the track policies linked below and make sure your changes comply with them all. This helps us focus our review time on the more important aspects of your changes.
Copy file name to clipboardExpand all lines: POLICIES.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ Our policies are not set-in-stone. They represent directions chosen at a point i
30
30
31
31
> Most (all?) exercises should be implemented in the form of instance methods since they contain "domain logic" and we (Exercism) want to encourage exemplary software.
`throw new UnsupportedOperationException("Delete this statement and provide your own implementation.");`
41
41
> - Exercises 21+: provide no stubs, but mention any "interesting" interface aspects in the HINT.md file (which gets merged into the README.md for the exercise).
> Starter implementations and test classes should not include the `final` keyword in class declarations as it isn't strictly necessary and could be confusing to people unfamiliar with Java.
44
48
45
49
### Ignore noninitial tests
46
50
47
51
> All but the first test in an exercise test suite should be annotated `@Ignore("Remove to run test")` (single test) or `@Ignore("Remove to run tests")` (parametrized test).
> The first exercise in the track whose test suite mandates multiple solution files should be accompanied by a HINT.md file reminding the practitioner that the CLI supports multiple file submissions.
> Aim to keep 10-20 small and straightforward issues open at eny given time. Identify any such issues by applying the "Good first patch" label. You can view the current list of these issues [here](https://github.com/exercism/xjava/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+patch%22).
63
+
> Aim to keep 10-20 small and straightforward issues open at eny given time. Identify any such issues by applying the "Good first patch" label. You can view the current list of these issues [here](https://github.com/exercism/java/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+patch%22).
> The Installing Java instructions should seek to minimize the number of steps and the number of concepts a new-to-the-track practitioner needs to learn to get to coding.
Copy file name to clipboardExpand all lines: README.md
+13-20Lines changed: 13 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
-
# xJava[](https://travis-ci.org/exercism/xjava)[](https://gitter.im/exercism/xjava?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
1
+
# java[](https://travis-ci.org/exercism/java)[](https://gitter.im/exercism/xjava?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2
2
3
3
Source for Exercism Exercises in Java.
4
4
5
5
## Contributing Guide
6
6
7
-
For general information about how to contribute to Exercism, please refer to the [Contributing Guide](https://github.com/exercism/x-api/blob/master/CONTRIBUTING.md#the-exercise-data).
7
+
For general information about how to contribute to Exercism, please refer to the [Contributing Guide](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks).
8
8
9
9
## Table of Contents
10
10
@@ -32,13 +32,13 @@ To submit a fix for an existing exercise or port an exercise to Java with the le
32
32
1.**Ensure you have the basic Java tooling installed:** JDK 1.8+, an editor and Gradle 2.x.
33
33
34
34
(see [exercism.io: Installing Java](http://exercism.io/languages/java/installing))
35
-
-**Setup a branch on a fork of [exercism/xjava](https://github.com/exercism/xjava) on your computer.**
35
+
-**Setup a branch on a fork of [exercism/java](https://github.com/exercism/java) on your computer.**
36
36
37
-
See [GitHub Help: Forking](https://help.github.com/articles/fork-a-repo/). Use those instructions (in conjunction with [Exercism Contributing Guide](https://github.com/exercism/x-common/blob/master/CONTRIBUTING.md#git-basics)) to:
37
+
See [GitHub Help: Forking](https://help.github.com/articles/fork-a-repo/). Use those instructions (in conjunction with the [Git Basics doc](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/git-basics.md)) to:
38
38
* "fork" a repository on GitHub;
39
39
- install `git`;
40
40
- "clone" a copy of your fork;
41
-
- configure an "upstream remote" (in this case, `exercism/xjava`);
41
+
- configure an "upstream remote" (in this case, `exercism/java`);
42
42
- create a branch to house your work
43
43
-**Write the codes.** Do your work on that branch you just created.
44
44
@@ -52,31 +52,31 @@ To submit a fix for an existing exercise or port an exercise to Java with the le
The Git Basics doc has a section on [commit messages](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/git-basics.md#commit-messages) that provides practical advice on crafting meaningful commit messages.
56
56
-**Verify that your work passes all tests.** When you create a pull request (PR), GitHub triggers a build on Travis CI. Your PR will not be merged unless those tests pass.
57
57
58
58
## Getting Familiar With the Codebase
59
59
60
60
There are two objectives to the design of this build:
61
61
62
-
1. when a problem is built from within the xjava repo, the tests run against the "example" code (i.e. when you, the contributor, are developing the exercise);
63
-
2. when a problem is built outside the xjava repo (when a participant is solving the exercise), the tests run against the "main" code.
62
+
1. when a problem is built from within the `exercism/java` repo(i.e. when you, the contributor, are developing the exercise), the tests run against the "example" code;
63
+
2. when a problem is built outside the `exercism/java` repo (when a participant is solving the exercise), the tests run against the "main" code.
64
64
65
65
This repo is a multi-project gradle build.
66
66
67
67
### The `exercises` Module
68
68
69
69
This is the top-level module, contained in the `exercises` directory. It is a container for the problem sub-modules.
70
70
71
-
*it's`build.gradle` points the "main" sourceset to the example code.
72
-
*it's`settings.gradle` names each of the subprojects, one for each problem in the set.
71
+
*its`build.gradle` points the "main" sourceset to the example code.
72
+
*its`settings.gradle` names each of the subprojects, one for each problem in the set.
73
73
74
74
### The Problem Submodules
75
75
76
76
The `exercises` subdirectory contains all of the problem submodules.
77
77
Each problem/submodule is a subdirectory of the same name as its slug.
78
78
79
-
*it's`build.gradle` names dependencies required to work that problem.
79
+
*its`build.gradle` names dependencies required to work that problem.
80
80
81
81
Each problem/submodule has three source sets:
82
82
@@ -109,18 +109,11 @@ and if you review the logs of your x-api, you'll find:
109
109
2015-09-06 15:21:01 - JSON::GeneratorError - source sequence is illegal/malformed utf-8:
110
110
```
111
111
112
-
This is because some files generated by the build can't be served from the x-api. This is by design: the CLI does not serve binaries. To fix this, simply make sure you do a clean in your `xjava` repo before you fetch:
112
+
This is because some files generated by the build can't be served from the x-api. This is by design: the CLI does not serve binaries. To fix this, simply make sure you do a clean in your `exercism/java` repo before you fetch:
0 commit comments