Skip to content

Latest commit

 

History

History
109 lines (72 loc) · 4.2 KB

CONTRIBUTING.md

File metadata and controls

109 lines (72 loc) · 4.2 KB
Raw

Contributing In General

Our project welcomes external contributions. If you have an itch, please feel free to scratch it.

To contribute code or documentation, please submit a pull request.

A good way to familiarize yourself with the codebase and contribution process is to look for and tackle low-hanging fruit in the issue tracker. Before embarking on a more ambitious contribution, please quickly get in touch with us.

Note: We appreciate your effort, and want to avoid a situation where a contribution requires extensive rework (by you or by us), sits in backlog for a long time, or cannot be accepted at all!

Proposing new features

If you would like to implement a new feature, please raise an issue before sending a pull request so the feature can be discussed. This is to avoid you wasting your valuable time working on a feature that the project developers are not interested in accepting into the code base.

Fixing bugs

If you would like to fix a bug, please raise an issue before sending a pull request so it can be tracked.

Merge approval

The project maintainers use LGTM (Looks Good To Me) in comments on the code review to indicate acceptance. A change requires LGTMs from two of the maintainers of each component affected.

For a list of the maintainers, see the MAINTAINERS.md page.

Legal

Each source file must include a license header for the Apache Software License 2.0. Using the SPDX format is the simplest approach. e.g.

/*
 * (C) Copyright <holder> <year of first update>[, <year of last update>]
 *
 * SPDX-License-Identifier: Apache-2.0
 */

We have tried to make it as easy as possible to make contributions. This applies to how we handle the legal aspects of contribution. We use the same approach - the Developer's Certificate of Origin 1.1 (DCO) - that the Linux® Kernel community uses to manage code contributions.

We simply ask that when submitting a patch for review, the developer must include a sign-off statement in the commit message.

Here is an example Signed-off-by line, which indicates that the submitter accepts the DCO:

Signed-off-by: John Doe <[email protected]>

You can include this automatically when you commit a change to your local git repository using the following command:

git commit -s

Communication

Connect with us by opening an issue. Join us on Slack

Setup

Alvearie imaging-ingestion is built with Gradle and requires Java 11 or higher. Since it is composed of several components, each component will be stored in a separate sub-folder of the imaging-ingestion repository. To build all components, execute the following from root folder:

./gradlew clean build

To build a specific component, execute the following from root folder:

./gradlew :<component>:build

Testing

To ensure a working build, please run the full build from the root of each pattern affected by your pull request before submitting.

Coding style guidelines

Alvearie imaging-ingestion is new. Formatting is not strictly enforced, but please consider the following points as you change the code:

  1. Write tests. Pull Requests should include necessary updates to unit tests (src/test/java of the corresponding project) and integration tests.

  2. Use comments. Preferably javadoc.

  3. Keep the documentation up-to-date. Project documentation exists under the docs directory.

  4. Use spaces (not tabs) in java source. We also prefer spaces over tabs in JSON and XML, but its not strictly enforced.

  5. Use spaces after control flow keywords (they're not function calls!); if/for/while blocks should always have { }

Leave the code better than you found it.

Branch naming convention

issue-#

Commit message convention

issue # - short description

long description