liquidvotingio / liquidvotingio/api
Update docs
Nobody has claimed this yet.
- Dominant language
- Elixir
- Stars
- 17
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
We should make sure:
- the docs are kept up-to-date
- examples that can be run as unit tests (because they don't have side-effects or require a complex set-up) should be tested with `doctest` (see #63)
- [typespecs](https://hexdocs.pm/elixir/typespecs.html#content); these aren't checked by the compiler but can be very useful documentation. They are checked by static code analysis tools like [credo](https://github.com/rrrene/credo) and [dialyzer](https://erlang.org/doc/man/dialyzer.html)).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the repository documentation and examples, and read issue #63 for the doctest context. Done means the documentation is current, suitable runnable examples are covered by doctest, and useful typespecs are present where appropriate; Credo and Dialyzer are the referenced analysis tools.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elixir
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100