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

Describe WHY we do things the way we do #81

Open
jsf9k opened this issue Jan 3, 2023 · 1 comment
Open

Describe WHY we do things the way we do #81

jsf9k opened this issue Jan 3, 2023 · 1 comment
Labels
documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use

Comments

@jsf9k
Copy link
Member

jsf9k commented Jan 3, 2023

💡 Summary

We do a decent job in this guide of describing the standards and practices we choose, but not such a great job of explaining why we chose them. We should make an effort to do so.

Motivation and context

In a dev team meeting today I mentioned that:

  • Historically we do a terrible job of getting new folks up to speed. If someone is a strong self-starter then they usually do OK, but our current process strongly selects for self-starters.
  • We have a difficult time getting contributors to read and follow the documentation in this repo.

It was mentioned that adding more explanation as to why we do things in the way we do might help with both issues.

@jsf9k jsf9k added documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use labels Jan 3, 2023
@jsf9k jsf9k changed the title Describe why we Describe WHY we do things the way we do Jan 3, 2023
@dav3r
Copy link
Member

dav3r commented Jan 3, 2023

Perhaps we need to finish start this document: https://github.com/cisagov/development-guide/tree/develop/ethos

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
None yet
Development

No branches or pull requests

2 participants