Add development environment setup guide #35
Conversation
Please note these are in-progress.
Updates formatting for markdown plus some minor fixes
Adds COOL setup instructions and some other minor updates
Adds more/better instructions for setting up a signing key. Fixes header depths and linting per the cisagov Markdown linting rules.
Adds a link to the CISA-provided Mac setup guide. Adds a link to the excellent "How to Write a Git Commit Message" guidelines.
hillaryj
added
the
documentation
hillaryj
requested review from
dav3r,
felddy,
jsf9k and
mcdonnnj
as code owners
Please note these are in-progress.
Updates formatting for markdown plus some minor fixes
Adds COOL setup instructions and some other minor updates
Adds more/better instructions for setting up a signing key. Fixes header depths and linting per the cisagov Markdown linting rules.
Adds a link to the CISA-provided Mac setup guide. Adds a link to the excellent "How to Write a Git Commit Message" guidelines.
…pment-guide into add-dev-env-setup
|
I rebased, since it was 3 months out of date, which added some extra commits. |
There was a problem hiding this comment.
I ran a first pass over everything (whew, it's a lot!), and this is some really great process documentation! ✨
I had some feedback, a lot of which (probably most) are changing bash and sh code block formatting to console. I'm of the opinion that the bash and sh formatting should be used for scripts, while the console formatting should be used for command line usage examples. This is what has happened in other cisagov repos, but I don't think anyone has touched up the markdown in this project to follow suite.
I'm a little more flexible about this. If I particularly want to highlight some shell fu in a command line I may use We need to codify these heretofore unwritten rules in a document once we agree on them. |
Co-authored-by: dav3r <[email protected]>
Co-authored-by: Nick M. <[email protected]>
Integrate suggested changes.
Co-authored-by: Nick M. <[email protected]>
Remove some of the redundancy from the Department of Redundancy Department.
Moves checklist to an issue template and changes wording to reflect this. Breaks out GitHub section in pre-reqs.
Separates Trio setup into its own section. Simplifies language around first issue. Separates and adds some buddy tasks.
|
I've captured some of the style discussion here in a proto style guide, which I'll continue adding to and add in a different PR. |
Co-authored-by: Nick M. <[email protected]>
Co-authored-by: Nick M. <[email protected]>
🗣 Description
Creates a guide with setup instructions for getting a CISA-provided mac laptop asset up and running.
Updates some framing language in other documentation to make it more accessible to new users.
💭 Motivation and Context
This guide previously existed in the google drive but was horrifically outdated. This update brings the guide in line with our open source policy and will help standardize future environment setup.
This also adds a link to the main README to include the excellent guide on writing git commit messages that the team uses.
For some of the other documentation guides, I added some extra language to make the topics more accessible to new users.
I also wanted to try out the new PR template 🎉
🧪 Testing
Documentation was linted and passed the pre-commit.
I tested the instructions as I wrote them, as well as got feedback from some of the interns.
🚥 Types of Changes
✅ Checklist