Skip to content

Commit

Permalink
Merge branch 'develop' into scroll-to-selection
Browse files Browse the repository at this point in the history
  • Loading branch information
jjti committed Feb 13, 2024
2 parents ae29dff + 450552d commit 07ebdb7
Show file tree
Hide file tree
Showing 7 changed files with 532 additions and 39 deletions.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing

This is living document describing how to contribute to SeqViz.

## Development

The sections below describe setting up the development environment and opening a PR against the `develop` branch.

### Setup

Before making or PR'ing changes, please set up and experiment with the demo application. Steps for doing that are described below.

Install `seqviz` packages in the repository and repository's demo directories:

```bash
# seqviz
npm i
cd ./demo
npm i
```

Start the demo application:

```bash
npm run start
```

Visit the demo application at [http://localhost:3010](http://localhost:3010) and experiment with sequence selection, clicking annotations, rotating the circular viewer, etc. As much as possible, try to validate that your change does not break existing functionality. The testing of `seqviz` is sparse; we rely on the demo application to catch regressions.

### PR

After making a change, open a PR against the `develop` branch and get it approved and merged by someone who works at Lattice Automation or [@jjti](https://github.com/jjti). They will merge it and cut a release.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
<img align=top src="./demo/public/logos-genomeminer.png" width="220" />
&nbsp; &nbsp; &nbsp; &nbsp;
<img align=top src="./demo/public/logos-corteva.jpeg" width="200" />
&nbsp; &nbsp; &nbsp; &nbsp;
<img align=top src="./demo/public/logos-betteromics.png" width="200" />
</div>

## Table of Contents
Expand Down
8 changes: 0 additions & 8 deletions demo/lib/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,6 @@ export default class App extends React.Component<any, AppState> {
name: "pLtetO-1 rev primer",
start: 512,
},
{
color: chooseRandomColor(),
direction: -1,
end: 535,
id: "52792saf3582",
name: "pLtetO-1 rev primer",
start: 512,
},
],
search: { query: "ttnnnaat" },
searchResults: {},
Expand Down
12 changes: 6 additions & 6 deletions demo/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added demo/public/logos-betteromics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 07ebdb7

Please sign in to comment.