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

Write 'what do we expect from PR' for external contributors #1239

Open
1 task
aboydnw opened this issue Nov 4, 2024 · 1 comment
Open
1 task

Write 'what do we expect from PR' for external contributors #1239

aboydnw opened this issue Nov 4, 2024 · 1 comment
Assignees

Comments

@aboydnw
Copy link
Contributor

aboydnw commented Nov 4, 2024

Context

As we scale to more deployments and more people outside of the core Dashboard team become involved in VEDA and its instances, we would like to have some documentation that helps those contributors. One idea is to have a document that describes what we would look for during a PR review. This could include some general guidance on creating a good PR, but we don't need to replicate all the other material out there on the internet. It should also include some guidance that is more VEDA-specific, like the different dependencies or potential effects that contributors should be aware of, or some common issues that we keep an eye out for when reviewing a PR.

Format is open, this could be a google doc or github documentation, or something else. We just want it to be accessible by new contributors as they come to VEDA from the different instance teams.

Acceptance Criteria

  • A document is easily accessible by new contributors, and IMPACT is aware of it (potentially linked to their onboarding doc)
@aboydnw
Copy link
Contributor Author

aboydnw commented Nov 4, 2024

@hanbyul-here I think the doc you started is good, maybe there are just some additions that are more VEDA-specific? Like specific issues you often see (env variables, mapbox tokens?) or other dependencies you think new contributors should be aware of.

Do you think this ultimately lives in Github or just as a google doc?

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

No branches or pull requests

2 participants