Skip to content

Commit

Permalink
Add contribution documentation
Browse files Browse the repository at this point in the history
This commit adds CONTRIBUTING.md to inform contributors of
important contribution policies, legal documents, agreements
and guidelines.

Signed-off-by: Hoang Thuan Pham <hoang.pham@calian.ca>
  • Loading branch information
hoangphamEclipse authored and bhufmann committed Apr 7, 2022
1 parent 8cae177 commit f297385
Show file tree
Hide file tree
Showing 2 changed files with 87 additions and 14 deletions.
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Contributing to Eclipse CDT Cloud Time Graph

Thanks for your interest in the [Eclipse CDT Cloud Time Graph][timegraph]!
The following is a set of guidelines for contributing to the project.

## How to Contribute

In order to contribute, please first [open an issue][issues] that clearly describes the bug you
intend to fix or the feature you would like to add. Make sure you provide a way to reproduce
the bug or test the proposed feature.

Once you have your code ready for review, please open a [pull request][pr].

A committer will then review your contribution and help to get it merged.

## Code of Conduct

This project is governed by the [Eclipse Community Code of Conduct][conduct].
By participating, you are expected to uphold this code.

## Eclipse Development Process

This Eclipse Foundation open project is governed by the [Eclipse Foundation
Development Process][dev-process] and operates under the terms of the [Eclipse IP Policy][ip-policy].

## Eclipse Contributor Agreement

In order to be able to contribute to Eclipse Foundation projects you must
electronically sign the [Eclipse Contributor Agreement (ECA)][eca].

The ECA provides the Eclipse Foundation with a permanent record that you agree
that each of your contributions will comply with the commitments documented in
the Developer Certificate of Origin (DCO). Having an ECA on file associated with
the email address matching the "Author" field of your contribution's Git commits
fulfills the DCO's requirement that you sign-off on your contributions.

For more information, please see the [Eclipse Committer Handbook][handbook].

## Contact

For questions related to the Time Graph, please open a GitHub [issue tracker][issues].

The Time Graph is part of `eclipse-cdt-cloud`. If you have any questions regarding CDT Cloud,
please refer to the contact options listed on the [CDT.Cloud website][cdt].

[cdt]: https://cdt-cloud.io/contact/
[conduct]: https://github.com/eclipse/.github/blob/master/CODE_OF_CONDUCT.md
[dev-process]: https://eclipse.org/projects/dev_process
[eca]: https://www.eclipse.org/legal/ECA.php
[handbook]: https://www.eclipse.org/projects/handbook/#resources-commit
[ip-policy]: https://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf
[issues]: https://github.com/eclipse-cdt-cloud/timeline-chart/issues
[pr]: https://github.com/eclipse-cdt-cloud/timeline-chart/pulls
[timegraph]: https://github.com/eclipse-cdt-cloud/timeline-chart
47 changes: 33 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,45 @@
[![Gitpod - Code Now](https://img.shields.io/badge/Gitpod-code%20now-blue.svg?longCache=true)](https://gitpod.io#https://github.com/theia-ide/timeline-chart)
[![Build Status](https://github.com/theia-ide/timeline-chart/workflows/CI-CD/badge.svg?branch=master)](https://github.com/theia-ide/timeline-chart/actions?query=branch%3Amaster)
# Time Graph

[![Gitpod - Code Now][gitpod-icon-small]][gitpod-link]
[![Build Status][build-status-icon]][build-status-link]

A time graph / gantt chart library for large data (e.g. traces)

To build, from the root type `yarn`

To test an application type `yarn start` then open localhost:8080 on your web browser

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/theia-ide/timeline-chart)
[![Open in Gitpod][gitpod-icon-large]][gitpod-link]

**👋 Want to help?** Read our [contributor guide][contributing].

# Documentation
For detailed description of the timeline chart library and it's components see [here](https://github.com/theia-ide/timeline-chart/blob/master/doc/documentation.md).
## Documentation

# Screenshots
For detailed description of the timeline chart library and it's components see [here][documentation].

![timeline-chart](https://raw.githubusercontent.com/theia-ide/timeline-chart/master/doc/images/screenshot1-0.0.1.png)
![timeline-chart](https://raw.githubusercontent.com/theia-ide/timeline-chart/master/doc/images/screenshot2-0.0.1.png)
## Screenshots

![timeline-chart][screenshot-1]
![timeline-chart][screenshot-2]

## Applications

# Applications
The following list of applications are currently making use of the timeline-chart library;
* [Theia Trace Extension](https://github.com/theia-ide/theia-trace-extension)
* [Example Timeline Application](https://github.com/theia-ide/theia-timeline-extension)

# Tests
* [Theia Trace Extension][trace-extension]
* [Example Timeline Application][sample-app]

## Tests

Tests can be executed from the root of the project with:

```
```shell
yarn test
```

Or from `./timeline-chart`, where the tests outputs are formatted in a more readable way:

```
```shell
cd timeline-chart
yarn test --verbose --watch
```
Expand All @@ -44,3 +51,15 @@ The following command prints a coverage report to the terminal. As of now it cov
```shell
yarn test --coverage --collectCoverageFrom='src/**/*.ts'
```

[build-status-icon]: https://github.com/theia-ide/timeline-chart/workflows/CI-CD/badge.svg?branch=master
[build-status-link]: https://github.com/theia-ide/timeline-chart/actions?query=branch%3Amaster
[contributing]: CONTRIBUTING.md
[documentation]: https://github.com/theia-ide/timeline-chart/blob/master/doc/documentation.md
[gitpod-icon-large]: https://gitpod.io/button/open-in-gitpod.svg
[gitpod-icon-small]: https://img.shields.io/badge/Gitpod-code%20now-blue.svg?longCache=true
[gitpod-link]: https://gitpod.io#https://github.com/theia-ide/timeline-chart
[sample-app]: https://github.com/theia-ide/theia-timeline-extension
[screenshot-1]: https://raw.githubusercontent.com/theia-ide/timeline-chart/master/doc/images/screenshot1-0.0.1.png
[screenshot-2]: https://raw.githubusercontent.com/theia-ide/timeline-chart/master/doc/images/screenshot2-0.0.1.png
[trace-extension]: https://github.com/eclipse-cdt-cloud/theia-trace-extension

0 comments on commit f297385

Please sign in to comment.