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
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,13 +49,13 @@ Getting Started
49
49
---------------
50
50
51
51
+ Make sure you have a [JIRA account](https://issues.apache.org/jira/).
52
-
+ Make sure you have a [GitHub account](https://github.com/signup/free).
52
+
+ Make sure you have a [GitHub account](https://github.com/signup/free). This is not essential, but makes providing patches much easier.
53
53
+ If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons BCEL's scope.
54
54
+ Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist.
55
55
+ Clearly describe the issue including steps to reproduce when it is a bug.
56
56
+ Make sure you fill in the earliest version that you know has the issue.
57
57
+ Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-),
58
-
[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository.
58
+
[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository. If you don't have a GitHub account, you can still clone the Commons repository.
More information can be found on the [Apache Commons BCEL homepage](https://commons.apache.org/proper/commons-bcel).
59
59
The [Javadoc](https://commons.apache.org/proper/commons-bcel/apidocs) can be browsed.
60
-
Questions related to the usage of Apache Commons BCEL should be posted to the [user mailing list][ml].
60
+
Questions related to the usage of Apache Commons BCEL should be posted to the [user mailing list](https://commons.apache.org/mail-lists.html).
61
61
62
-
Where can I get the latest release?
63
-
-----------------------------------
62
+
Getting the latest release
63
+
--------------------------
64
64
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-bcel/download_bcel.cgi).
65
65
66
-
Alternatively you can pull it from the central Maven repositories:
66
+
Alternatively, you can pull it from the central Maven repositories:
67
67
68
68
```xml
69
69
<dependency>
70
70
<groupId>org.apache.bcel</groupId>
71
71
<artifactId>bcel</artifactId>
72
-
<version>6.7.0</version>
72
+
<version>6.8.1</version>
73
73
</dependency>
74
74
```
75
75
76
+
Building
77
+
--------
78
+
79
+
Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
80
+
The required Java version is found in the `pom.xml` as the `maven.compiler.source` property.
81
+
82
+
From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks.
83
+
76
84
Contributing
77
85
------------
78
86
79
87
We accept Pull Requests via GitHub. The [developer mailing list](https://commons.apache.org/mail-lists.html) is the main channel of communication for contributors.
80
88
There are some guidelines which will make applying PRs easier for us:
81
89
+ No tabs! Please use spaces for indentation.
82
-
+ Respect the code style.
90
+
+ Respect the existing code style for each file.
83
91
+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
84
92
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
85
93
@@ -88,13 +96,13 @@ You can learn more about contributing via GitHub in our [contribution guidelines
88
96
89
97
License
90
98
-------
91
-
This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
99
+
This code is licensed under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).
92
100
93
101
See the `NOTICE.txt` file for required notices and attributions.
94
102
95
-
Donations
96
-
---------
97
-
You like Apache Commons BCEL? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
103
+
Donating
104
+
--------
105
+
You like Apache Commons BCEL? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support development.
0 commit comments