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

[suggestion] Listing anti-patterns in README #279

Open
gyermolenko opened this issue Feb 7, 2019 · 1 comment
Open

[suggestion] Listing anti-patterns in README #279

gyermolenko opened this issue Feb 7, 2019 · 1 comment
Labels

Comments

@gyermolenko
Copy link
Contributor

@gyermolenko gyermolenko commented Feb 7, 2019

I think listing anti-patterns with some basic reasoning about "why not" is a good idea.

Example - singleton. Although #256 has "won't fix" label

  • it is in PRs section, and people (if searching history at all) are searching issues first.
  • it was misspelled, Singelton instead of Singleton, therefore impossible to find

Listing most popular anti-patterns (without actual implementation) should allow people to find the name from readme

  • immediately assume it was'n just missed by mistake
  • see why it is not welcome for python projects
@faif
Copy link
Owner

@faif faif commented Feb 8, 2019

Indeed this case save us time. Instead of pointing people to the closed issues that are not easily visible, they will hopefully read the README and find some answers to their questions.

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

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.