Skip to content

Latest commit

 

History

History
124 lines (81 loc) · 6.29 KB

CONTRIBUTING.md

File metadata and controls

124 lines (81 loc) · 6.29 KB
Raw

Contributing to clojurephant

Asking a question or getting help

The following is the preferred communication channel:

The following are not actively monitored:

Submitting a bug report or feature request

Create a new issue and fill out the template. Thanks for providing feedback on what's important to you as a user!

Roadmap

See the milestones for details on planned features.

Contributing documentation or code

Pull requests are very welcome. Thanks in advance for helping the project (that goes double for those of you updating documentation)!

  • For minor changes: Go right ahead and submit a PR.
  • For already open issues: Comment in the issue that you'd like to help out on to ensure it's not already being worked on and to get guidance from the team.
  • For new features: Open an issue first detailing the feature. This will let the team provide feedback on how that feature can work best for the project.

Development Setup

  • Clone this repo.
  • Have a Java 8 or higher JDK installed.
  • If using Eclipse or Intellij:
    • Import the project as a Gradle project.
    • Import the Eclipse formatter preferences from .gradle/eclipse-java-formatter.xml. (See Code Style for more information.)

Project Structure

  • Documentation is under docs/.
  • Modules:
    • Plugin itself is in clojurephant-plugin/
  • Test suite:
    • Functional Gradle tests (run against a range of Gradle versions) are in clojurephant-plugin/src/compatTest
  • Sample Projects:
    • These are separate repositories under the Clojurephant organization

Gradle Resources

A few helpful resources if you're new to writing Gradle plugins:

Testing Sample Projects

  1. Clone the sample repo
  2. Use the project like normal to test its functionality

Code Style

This project uses the Google Java Style Guide. Google provides google-java-format and an Eclipse formatter profile to help automate this. Both however have a weakness in how they line wrap, primarily for code that heavily uses lambdas. The style guide's text allows for more discretion in where line wrapping happens, but the automated ones can be overzealous. For this reason, we are using a modified version of the Eclipse profile that disables the automatic line wrapping.

The style is enforced using the spotless plugin, which can also reformat your code to comply with the style with ./gradlew spotlessApply.

You can import the Eclipse formatter settings .gradle/eclipse-java-formatter.xml to have your IDE respect the style.

Maintainer/Collaborator Processes

CI Configuration

clojurephant is built on GitHub Actions. This is configured in .github/workflows/*.yaml.

There are two workflows:

  • ci - General build verification running on all branches and PRs on push:
    • Runs full ./gradlew check and ./gradlew compatTest test suites and style verification.
    • Runs on all supported Java versions (currently 8, 11, 17).
  • release - Publishing the plugin to Gradle's Plugin Portal and Clojars
    • When a tag is pushed, it will do a release/publish (i.e. don't make a tag unless you're trying to release).

Updating our dependencies

To update the lock with the latest versions matching any ranges we specified:

./gradlew lock --write-locks

Supporting new Gradle versions

The following task will update our lock files will the latest available versions that match the compatibility rules in our stutter {} block in clojurephant-plugin/build.gradle.

./gradlew stutterWriteLocks

The stutter {} block can also be used to change the ranges we support. See stutter's documentation for details.

Release Process

We use reckon to manage our versioning and tagging. There is no version number stored in the build file, reckon will determine this automatically from the project history and user input.

We have 3 release stages:

  • beta - significant functionality that we'd like to release but the version isn't feature-complete yet
  • rc - intended as a final release, but want to provide an opportunity for bug testing
  • final - no known or significant bugs were found in the rc, and it's ready for general consumption

To generate a release:

  • (For rc or final) Make sure all issues in GitHub milestone.
  • (For final) make sure we've released an rc already for this commit.
  • Have the master branch checked out
  • Run ./gradlew reckonTagPush -Preckon.stage=<stage> (e.g. ./gradlew reckonTagPush -Preckon.stage=beta)
    • This will run check on the project, create a version tag, and push that tag
    • The tag push will trigger GitHub Actions to run the release workflow, including the publish step if tests pass on all supported Java versions.
    • The publish will push the plugin to Clojars, and the Gradle Plugin Portal.
  • Go to the GitHub releases and draft a new release. Use the template for consistency. Ensure you check the is a pre-release if this is a beta or rc.