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

Docs improvements in README.md #137

Merged
merged 7 commits into from
Oct 11, 2023
Merged

Conversation

spier
Copy link
Contributor

@spier spier commented Oct 10, 2023

Documentation fixes in the main README.md.

Proposed Changes

  • Some rewording in the first sentence, highlighting that the output of the GHA is a GitHub issue.
  • minor bug fix (double space)
  • minor cosmetics fixes in the markdown (not visible for the general readers, just for people reading the markdown)
  • I am also leaving one question as a comment in this PR, about an area where I am not sure how the * footnotes are supposed to be formatted

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request
  • run make lint and fix any issues that you have introduced
  • run make test and ensure you have test coverage for the lines you are introducing
  • Label as either bug, documentation, enhancement, infrastructure, or breaking

@spier spier requested a review from zkoppert as a code owner October 10, 2023 21:49
README.md Outdated Show resolved Hide resolved
@spier
Copy link
Contributor Author

spier commented Oct 10, 2023

I cannot add a label, as requested in the instructions.

@spier
Copy link
Contributor Author

spier commented Oct 10, 2023

In order to make lint as the instructions request, I had to pip3 install flake8 pylint.

Not sure if those two dependencies are missing from requirements.txt?
(maybe not, if they are only required when developing/testing?)

@zkoppert zkoppert added the documentation Improvements or additions to documentation label Oct 11, 2023
@zkoppert
Copy link
Member

I cannot add a label, as requested in the instructions.

Thanks for catching this!
Fix this here: 3dd3d58

@zkoppert
Copy link
Member

In order to make lint as the instructions request, I had to pip3 install flake8 pylint.

Not sure if those two dependencies are missing from requirements.txt? (maybe not, if they are only required when developing/testing?)

I've got a pull request open to fix this. Another great find. Thanks for bringing it to my attention @spier!

Copy link
Member

@zkoppert zkoppert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 Thanks for the fixes and improvements!! Really appreciate you taking the time to upstream these and help the next user that has to read these docs!

@zkoppert zkoppert merged commit e3a26cc into github:main Oct 11, 2023
4 checks passed
@zkoppert zkoppert self-assigned this Oct 11, 2023
@spier spier deleted the docs-improvements branch October 11, 2023 11:33
@spier spier mentioned this pull request Oct 12, 2023
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants