-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into scroll-to-selection
- Loading branch information
Showing
7 changed files
with
532 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.