Add documentation for developers - Githubissues

Nagasaki45 / bibo

Command line reference manager with a single source of truth: the .bib file. Inspired by beets.

MIT License

32 stars 4 forks source link

Add documentation for developers #57

Closed Nagasaki45 closed 4 years ago

Nagasaki45 commented 4 years ago

[x] How to install development environment
[x] Running tests + linter
[x] Submitting PRs to the dev branch
[x] When submitting PRs, try to include the issue number in the commit message if relevant, as per this tutorial. Use #XXX to reference the issue or Fix: #XXX if issue fixed by the commit.
[x] Building the docs
[x] Working on plugins

Kappers commented 4 years ago

Would code coverage be included in 'running tests'?

Might be worth considering the below:

[ ] Style guidelines

Maybe even worth using some continuous integration service (travis or circle) and including some linting tool?

Nagasaki45 commented 4 years ago

Would code coverage be included in 'running tests'?

I don't think we should actively worry about that. Coverage runs automatically by travis.

Might be worth considering the below:
* [ ]  Style guidelines
Maybe even worth using some continuous integration service (travis or circle) and including some linting tool?

Agree completely! Opened #63 for that.