mirror of
https://github.com/indentlabs/notebook.git
synced 2025-10-26 11:19:22 +00:00
Update CONTRIBUTING.md
This commit is contained in:
parent
e8afa326b3
commit
032508b771
41
.github/CONTRIBUTING.md
vendored
41
.github/CONTRIBUTING.md
vendored
@ -1,8 +1,35 @@
|
||||
flow for a new feature is:
|
||||
# Contributing
|
||||
|
||||
1. branch feature branch off master
|
||||
2. dev feature
|
||||
3. submit PR
|
||||
4. travis build is automatically run for that branch, reported on PR
|
||||
5. merge PR into master
|
||||
6. travis build automatically runs for master, deploys if tests still pass
|
||||
## 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.
|
||||
[Travis-ci][travis] is building 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 Travis build must pass
|
||||
|
||||
[travis]: https://travis-ci.org/indentlabs/notebook
|
||||
[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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user