Skip to content

[Enhancement] Option Overview in README #7

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.

Sign up for GitHub

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

Jump to bottom
Closed
kevinmatthes opened this issue May 20, 2022 · 5 comments
Closed

[Enhancement] Option Overview in README #7

kevinmatthes opened this issue May 20, 2022 · 5 comments

Comments

@kevinmatthes
Copy link
Contributor

This issue originates from #6 and was created in order to mark it as an open task.

The application documentation could be enhanced by adding an overview about the configured options to the repository README.
@kevinmatthes
Copy link
Contributor Author

The minimal approach would be to just paste the output of commit-analyzer --help to the README. What do you think about that, @wert007?

@wert007
Copy link
Owner

wert007 commented May 20, 2022

The minimal approach would be to just paste the output of commit-analyzer --help to the README. What do you think about that, @wert007?

That's exactly how I would do it 👍

@kevinmatthes
Copy link
Contributor Author

I will add it to #9.

@kevinmatthes
Copy link
Contributor Author

But before, we should rather finish the discussion of #10.

@kevinmatthes kevinmatthes mentioned this issue May 21, 2022
Closed
@kevinmatthes
Copy link
Contributor Author

🔧 ✔️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@wert007 @kevinmatthes