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

Document Go dependencies & build steps #4165

Closed
Tracked by #3829
ford-at-aws opened this issue Jan 4, 2023 · 0 comments
Closed
Tracked by #3829

Document Go dependencies & build steps #4165

ford-at-aws opened this issue Jan 4, 2023 · 0 comments
Assignees

Comments

@ford-at-aws
Copy link
Contributor

ford-at-aws commented Jan 4, 2023

NOTE ⚠️

Your language's existing top-level README may already meet the acceptance criteria defined below. If this is the case, let me (@ford-at-aws) know and I'll review it and close your story if true.

User story

As an example code customer, I want to know which dependencies are required in order to build and execute the examples themselves, and how to resolve those dependencies myself after cloning the code.

So that...

I can use this code without having to guess. (and also so that the internal AWS team can create build/test automation).

Acceptance criteria

I know this is done when:

  • Steps are documented in language-level README
  • Includes your OS (or OS's where code has been verified to work)
  • Includes all external dependencies or third-party libraries (and where to see them in the code, e.g. pom.xml)
  • Includes steps to resolve dependencies or build source code that a user could follow
  • All of the above is documented in the language-level README
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