oracle / oracle/macaron

Add documentation on how the HTML reports are created

Open
#314 0 comments 0 reactions 1 assignee View on GitHub

@tromai is already working on this.

Since Jun 14, 2023.

documentation report
Dominant language
Python
Stars
210
Forks
36
Avg merge
1d 10h
Merged PRs (30d)
2

Description

Description
This PR is used to track the progress of adding the documentation for maintaining the HTML reports created by Macaron (in the Sphinx documentation's Deverloper Reference section or as a README).
Some of contents that I currently think of (and potentially add more in the future):

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.