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

How about "known issues" document? #3

Closed
pocke opened this issue Jul 12, 2021 · 4 comments
Closed

How about "known issues" document? #3

pocke opened this issue Jul 12, 2021 · 4 comments

Comments

@pocke
Copy link
Member

pocke commented Jul 12, 2021

This gem has known issues, so I think it is more helpful if a known issue document exists.

I know the following issues:

@mame
Copy link
Member

mame commented Jul 12, 2021

Looks good. Where should we put such a document? Wiki, known_issues.md, or doc/ directory?

@ttanimichi
Copy link

The bottom of the README would be a good place

@pocke
Copy link
Member Author

pocke commented Jul 12, 2021

I think the README must have links to the known issues at least, but the details should be another place to keep the README short.
I think GitHub Issue will be a good place, because we manage issues with GitHub Issue. It will avoid managing the same things in two places.

@mame
Copy link
Member

mame commented Jul 12, 2021

I've created #4, #5 and #6

@mame mame closed this as completed Nov 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants