-
Notifications
You must be signed in to change notification settings - Fork 39
Open
Labels
documentationnon-functional update to docs or how-tosnon-functional update to docs or how-tosgood first issueGood for newcomersGood for newcomers
Description
Ran through some suggestions for the README.md provided by @alainlubin and @danf425. Some high-level topics discussed included:
- Make sure the instructions call out running a
terraform initon a user's first spin-up, as theterraform applywill fail if this is not done - Update the
sup-logsection of local specifying actrl+cto exit out when you're done. - Guidence on working with branches for contributing or working with PRs (this can likely go in a separate CONTRIBUTING.md)
Thinking of using this as a good topic to get some folks together for a quick contributing session to guide folks through the git-fu required to get changes pushed to the repo.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationnon-functional update to docs or how-tosnon-functional update to docs or how-tosgood first issueGood for newcomersGood for newcomers