Skip to content

Commit

Permalink
Prepare for the next release candidate
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Aug 10, 2024
1 parent ae79357 commit 22d5201
Show file tree
Hide file tree
Showing 7 changed files with 415 additions and 555 deletions.
21 changes: 4 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,8 @@
Contributing to Apache Commons VFS Project
======================

You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to
the open source community. Before you dig right into the code there are a few guidelines that we need contributors to
follow so that we can have a chance of keeping on top of things.
Have you found a bug or have an idea for a cool new feature? Contributing code is a great way to give something back to the open-source community.
Before you dig right into the code, we need contributors to follow a few guidelines to have a chance of keeping on top of things.

Getting Started
---------------
Expand All @@ -62,7 +61,7 @@ Making Changes

+ Create a _topic branch_ for your isolated work.
* Usually you should base your branch on the `master` branch.
* A good topic branch name can be the JIRA bug id plus a keyword, e.g. `VFS-123-InputStream`.
* A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `VFS-123-InputStream`.
* If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests.
+ Make commits of logical units.
* Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue.
Expand All @@ -72,7 +71,7 @@ Making Changes
+ 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 first.
+ Check for unnecessary whitespace with `git diff` -- check before committing.
+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`.
+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken.
+ Run all the tests with `mvn clean verify` to ensure nothing else was accidentally broken.

Making Trivial Changes
----------------------
Expand All @@ -82,18 +81,6 @@ The JIRA tickets are used to generate the changelog for the next release.
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA.
In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number.

Testing
-------

Please add unit tests for any fixes or new features.

When running individual tests, tests that extend `AbstractProviderTestCase`
(such as `NamingTests`) cannot be run in isolation: instead, you can run them
'in the context of' a provider, for example from `LocalProviderTestCase`.
These configure a `ProviderTestSuite` with the tests to run.

This could likely be simplified, we are tracking that possible
improvement in https://issues.apache.org/jira/browse/VFS-855 .

Submitting Changes
------------------
Expand Down
10 changes: 5 additions & 5 deletions NOTICE.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Apache Commons VFS Project
Copyright 2002-2024 The Apache Software Foundation
This product includes software developed at
The Apache Software Foundation (https://www.apache.org/).
Apache Commons VFS Project
Copyright 2002-2024 The Apache Software Foundation

This product includes software developed at
The Apache Software Foundation (https://www.apache.org/).
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Getting the latest release
--------------------------
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-vfs/download_vfs.cgi).

Alternatively, you can pull it from the central Maven repositories:
Alternatively, you can pull it from the central Maven repositories:

```xml
<dependency>
Expand All @@ -75,7 +75,7 @@ Alternatively, you can pull it from the central Maven repositories:
Building
--------

Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
The required Java version is found in the `pom.xml` as the `maven.compiler.source` property.

From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks.
Expand All @@ -88,7 +88,9 @@ There are some guidelines which will make applying PRs easier for us:
+ No tabs! Please use spaces for indentation.
+ Respect the existing code style for each file.
+ 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.
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`.
+ Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks.
+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false`

If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
Expand Down
Loading

0 comments on commit 22d5201

Please sign in to comment.