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

docs: improve external contribution experience #4351

Closed
2 of 3 tasks
weikanglim opened this issue Sep 19, 2024 · 1 comment
Closed
2 of 3 tasks

docs: improve external contribution experience #4351

weikanglim opened this issue Sep 19, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@weikanglim
Copy link
Contributor

weikanglim commented Sep 19, 2024

I'm creating this issue to discuss ideas and track improvements around making azd external contributions easier. I've looked into the current state of azd from an external lens, and broadly speaking, I think we want to do something along the lines of the following:

  • Rewrite CONTRIBUTING.md to assume limited knowledge with azd for building, running or testing azd
  • Move docs and CONTRIBUTING.md to a more visible location. We currently aren't following the best practices for github contributing guides. It should either be under .github or docs. Personally, I've found the cli/azd/docs location to be quite inaccessible. -- For now, we'll keep it as-is since it's linked in the root contributing.md
  • Some broad guidelines around pull requests and issues in CONTRIBUTING.md.
@weikanglim weikanglim added the documentation Improvements or additions to documentation label Sep 19, 2024
@weikanglim weikanglim added this to the Backlog milestone Sep 19, 2024
weikanglim added a commit that referenced this issue Sep 20, 2024
Rewrite contributing to assume little-to-no-prior knowledge of go.

Completes #4351
@weikanglim
Copy link
Contributor Author

Was able to find enough time with #4355 to complete the two tasks above, and removed requirement 2 after brief discussion with Matt.

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