indentlabs/notebook

View on GitHub
.github/CONTRIBUTING.md

Summary

Maintainability
Test Coverage
# Contributing

## Reporting bugs and other issues

To report any issues with the site, please [create an issue report].
If you could add the following information to the report, tracking the issue down and fixing it becomes a lot easier.

1. What you expected to see
1. What you saw instead
1. What steps you took to trigger the problem

Screenshots are great!
Drag & drop or paste images into the issue form.

## Fixing Bugs

Check out our [issue tracker] and see what we're working on.
We also keep ideas in there, and you are welcome to jump into the conversation.

## Adding and updating features

Please [create a pull request][pr] to implement features you'd like to see.
GitHub Actions builds every pull request,
so we'll have prompt feedback on the progress of the feature implementation.
We require a few things in order to merge a pull request:

 - You must merge `master`'s latest commit
 - There must be no merge conflicts
 - Your new feature must be covered by tests
 - The test build must pass

[pr]: https://github.com/indentlabs/notebook/compare/
[create an issue report]: https://github.com/indentlabs/notebook/issues/new
[issue tracker]: https://github.com/indentlabs/notebook/issues