Skip to content
/ HAnS Public

HAnS - Helping Annotate Software. HAnS is an open-source (Apache 2.0) plugin for IntelliJ that helps you annotate software.

License

Notifications You must be signed in to change notification settings

isselab/HAnS

Repository files navigation

HAnS (Helping Annotate Software)

Build Version Downloads License Static Badge

HAnS is a plugin that aims to help developers with annotating software assets with features.

The features of HAnS are:

  • Feature Annotation Languages
  • Mapping code fragments to features
  • Mapping files or directories to features
  • Completion aid when annotating
  • Feature Model View
  • Referencing
  • Renaming features
  • Quick fixes
  • Live templates

Installation

  • Using the IDE built-in plugin system:

    Settings/Preferences > Plugins > Marketplace > Search for "HAnS" > Install

  • Manually:

    Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

Contribution guidelines

You are free to contribute to this repository.

Getting started

  • Fork the repository
  • Start adding your contribution as an annotated feature in the code
  • Build and Test
  • Make a pull request

To build and test you new snippet run the gradle [runIde] task.

Pull requests should be named like this: folder-featureName-contributor-description.

Folder can be either Feature or Bug. FeatureName should be one that is already in the featuremodel or some new featureName. Lastly contributor is your git name and the description should be a short description of the new feature or the bug.

As a reviewer

The repository has policies in place (similar to other Git repositories) for which a team of members is responsible for ensuring the code quality of the features before they can be merged to the main branch. If you have experience with plugin development or want to help out by becoming a member of the review team, please reach out and contact any member in the existing team.

Current review group

jhc github jhc github

Who do I talk to?

jhc github jhc github

Research group

jhc github

Chair of Software Engineering

Chair of Software Engineering

Papers published:

2021
  • Master Thesis by Johan Martinson & Herman Jansson
    Johan & Herman
  • HAnS: IDE-based editing support for embedded feature annotations by Johan Martinson, Herman Jansson, Mukelabai Mukelabai, Thorsten Berger, Alexandre Bergel, and Truong Ho-Quang.