Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

52 lines (31 loc) · 2.68 KB

ia2-annotation-tool Contributing Guide

Hi! We're really excited that you are interested in contributing to ia2-annotation-tool. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:

Issue Reporting Guidelines

  • Always use our bug or feature templates to create an issue.

Pull Request Guidelines

  • The main branch is just a snapshot of the latest stable release. All development should be done in dedicated branches. Do not submit PRs against the main branch.

  • Checkout a topic branch from the relevant branch, e.g. develop, and merge back against that branch. Please follow this convention for the new branch: issueNumber-githubUsername-commitTitle.

  • Most of the contributed work should generally target the src directory or the assets directory on rare occasions when the client needs a javascript poke.

  • It's OK to have multiple small commits as you work on the PR. We may squash them before merging if necessary.

  • If adding a new feature:

    • Add accompanying test cases.
    • Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.

  • If fixing a bug:

    • If you are resolving a special issue, please follow the branch naming convention mentioned above.
    • Provide a detailed description of the bug in the PR. Live demo preferred.
    • Add appropriate test coverage if applicable.

Development Setup

You will need Node, preferably versión 12.18.2 or later.

After cloning the repository, follow the development instructions in README.md

Committing Changes

We don't expect any strict convention, but we'd be grateful if you summarize what your modifications content is about when writing a commit.

Project Structure

  • src/lib: <DIR> contains exported components to use in the host application
  • src/index.js: <FILE> component usage example

Attribution

This Contributing Guidelines were adapted from the Vue.js Contributing Guide.