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

Update contributing documentation #34785

Open
DanielRosenwasser opened this issue Oct 28, 2019 · 1 comment
Open

Update contributing documentation #34785

DanielRosenwasser opened this issue Oct 28, 2019 · 1 comment
Assignees
Labels
Docs The issue relates to how you learn TypeScript Infrastructure Issue relates to TypeScript team infrastructure
Milestone

Comments

@DanielRosenwasser
Copy link
Member

@RyanCavanaugh recently walked through CONTRIBUTING.md and our wiki and commented that the process is a bit old and crusty. In the interest of making things more obvious for contributors, we need to clean things up here.

@DanielRosenwasser DanielRosenwasser added Docs The issue relates to how you learn TypeScript Infrastructure Issue relates to TypeScript team infrastructure labels Oct 28, 2019
@DanielRosenwasser DanielRosenwasser added this to the TypeScript 3.8.0 milestone Oct 28, 2019
@ghost
Copy link

ghost commented Dec 4, 2019

I'm currently trying to get an overview of the project, including contribution etc.

The project-host (github) is not very helpful with this:

  • 3891 issues
  • 112 Issue-Labels in one(!) level
  • zero functionality for "subsystems" or "components"

Any serious issue-tracker for larger projects (like typescript is) has fields for:

  • Issue-Category (bug, feature, enhancement, question etc.)
  • Severity (on user side)
  • Priority (from team)
  • most (MOST) important: Component (or Subsystem)

Don't believe this"

Test:

  • Focus on the "compiler" subsystem within the typescript code.
  • Get notifications ONLY for src/compiler subsystem.
  • Follow Issues for the "compiler" subsystem.

=> you can't, because Github does not support this.

Why? Because the early Gihub-product-managers had "flat" thinking, and the masses were fine with it.

An excellent system needs zero documentation, because it's self-documenting.

But! A system full of weaknesses and flaws needs many documentation.

Fix those very fundamental github weaknesses, then start to write contributor-documentation.

4000 issues, 113 labels, seriously, you don't see the usability disaster here?

.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs The issue relates to how you learn TypeScript Infrastructure Issue relates to TypeScript team infrastructure
Projects
None yet
Development

No branches or pull requests

2 participants