Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(doc): Update package links in README #131

Merged
merged 1 commit into from
Jan 26, 2024
Merged

Conversation

buhtz
Copy link
Contributor

@buhtz buhtz commented Jan 24, 2024

Hello,

  • TravisCI badge removed because the link was dead and I assume you migrated to Microsoft GitHub Actions because they also do exist
  • Package links to Debian and Arch are updated.
    • Debian now points to the source package independet from a specific Debian release.
    • Arch moved the package from AUR to its "extra" repo. I treat this as "official". But I am not sure about that.

Please let me add two problems I discovered:

  1. I couldn't find a contribution information (e.g. CONTRIB.md) or something else. It is not clear how to provide a PR. I assume the develop branch is the correct target.
  2. The README.md suffix indicates this is a markdown file. But its content make it clear that it is a restructured-text (rst) file.

@buhtz
Copy link
Contributor Author

buhtz commented Jan 24, 2024

Mhm... I branched from the default branch main but targeting the PR to develop. Sorry for that. That roots to multiple commits.
Please advice how to solve this problem.

You see how important a contribution info is.

@borntyping borntyping deleted the branch borntyping:main January 24, 2024 18:26
@borntyping borntyping closed this Jan 24, 2024
@borntyping
Copy link
Owner

I've removed the develop branch which isn't in use (I think I created it while working on the v4/v5/v6 migration), though didn't expect that to close this PR. Changes should target the main branch.

I'll see about writing a tiny CONTRIBUTING document at some point, though it's not a high priority as this repo doesn't see many changes.

@borntyping
Copy link
Owner

The current README file should also be in markdown, any RST format in there is probably a leftover from long ago and likely needs fixing.

@buhtz
Copy link
Contributor Author

buhtz commented Jan 24, 2024

Why do you closed the issue without merging?
As maintainer you can re-target the PR. It is quit easy. No need to create another PR. just click on "Edit" button right from the PR headline.
Or won't you accept the PR. Your statement wasn't clear for me about that.

The current README file should also be in markdown

For example the headings in in rst-format.

Log formatting with colors!
===========================

Status
------

Should be in markdown

# Log formatting with colors!

## Status

I discovered this because I wasn't able to create a markdown TOC. These are not recognized as headings.

@borntyping
Copy link
Owner

I'm not seeing a way to retarget the PR, clicking edit only seems to let me edit the PR title and not change the branch. I didn't intentionally close it, GitHub automatically did that when I deleted the unused and confusing develop branch.

These changes are still very welcome.

These are not recognized as headings.

These are completely valid headings (https://github.github.com/gfm/#setext-headings), but you're welcome to change them if it would make them more compatible with the tool you're using.

@borntyping borntyping reopened this Jan 25, 2024
@borntyping borntyping changed the base branch from develop to main January 25, 2024 00:12
@borntyping
Copy link
Owner

Ah, you can't retarget or reopen a closed PR! I created a new develop branch, then reopened the PR, then retargeted it, then deleted the develop branch. How very arkward.

@borntyping
Copy link
Owner

There's a single CI failure but I don't think it has anything to do with these changes. It's late here, I'll look at fixing it in the morning and merging these changes after. :)

@borntyping borntyping merged commit 4625f8c into borntyping:main Jan 26, 2024
11 of 12 checks passed
@buhtz buhtz deleted the patch-1 branch January 26, 2024 13:43
borntyping added a commit that referenced this pull request Jan 26, 2024
@borntyping
Copy link
Owner

Changes published in 6.8.2, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants