OpenLogicProject / OpenLogicProject/OpenLogic

PDF generation for reviewing changes in pull requests

Open
#148 14 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
1.4k
Forks
288
PR merge metrics
No merged PRs in 30d

Description

I started with reading OpenLogic a few days ago, and I am delighted to see a project like this. Thus, I want to contribute while I read the book and make notes for learning the written material. Watching open pull requests for content, that I already read or will read soon, is what I have done. While reviewing, I found it hard, especially for larger texts, to compare them using a diff utility. A beneficial feature would be, that for example, Travis CI automatically generates a PDF document, with the data from the pull request, while doing checks, for reviewing the changes more clearly.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by examining the Travis CI checks and the pull-request content workflow described in the issue. Define what pull-request data the PDF should contain and verify that the generated document makes larger content changes easier to compare.

Written by the indexing model from the issue text.

Assessment

Tech stack
tex
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.