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

[meta] Improve contributor experience #84

Open
jnv opened this issue Oct 4, 2021 · 1 comment
Open

[meta] Improve contributor experience #84

jnv opened this issue Oct 4, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@jnv
Copy link
Contributor

jnv commented Oct 4, 2021

I would like to suggest the following improvements to help possible contributors:

  • Currently the Issues flow is a generic one offering only possibility to submit a bug or question, we could:
    • Improve the Bug template to better capture bugs with existing capabilities through explicit questions in this area (i.e. "What capability is affected?" "What provider you use?") and also provide explicit instructions on capturing debugging information
    • Open Discussions for this repository to capture capabilities / providers requests.
    • Add specific options to "Request new capability" and "Request new vendor" guiding the user to Discussions
  • Streamline the Contribution guidelines
    • Currently it's mostly a generic guide with only a few some repo-specific suggestions and it's easy to miss some important things like Conventions
    • For example we don't explain anywhere how to do testing (and that you probably shouldn't run all the tests since you don't have all the necessary keys)
    • It might be helpful also to explain in better detail what kinds of contributions are welcome and where to look for requested capabilities / providers.
  • Why we do have Changelog here?
@jnv jnv added documentation Improvements or additions to documentation good first issue Good for newcomers and removed good first issue Good for newcomers labels Oct 4, 2021
@jnv
Copy link
Contributor Author

jnv commented Oct 4, 2021

We could use DefinitelyTyped for inspiration.

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

No branches or pull requests

1 participant