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

Create some sort of architecture philosophy document #8

Open
cwlsn opened this issue Sep 3, 2018 · 0 comments
Open

Create some sort of architecture philosophy document #8

cwlsn opened this issue Sep 3, 2018 · 0 comments
Labels
🗄️ new dependencies Changes to project dependencies were made. 🏡 housekeeping Updates that don't impact the code, but keep the project running smoothly. 📃 documentation Changes to documentation were made. 🍽️ chore Basic tasks to keep things updated or working correctly. 📜 scripts change A change to any of the scripts in package.json.

Comments

@cwlsn
Copy link
Owner

cwlsn commented Sep 3, 2018

Preamble

I find myself doing things differently while creating this repo and companion content, trying to focus on defaults of libraries. I would normally not use a .storybook directory and opt for my own config folder, but keeping scripts as simple as possible is really refreshing. I feel like I am constantly coercing my projects to work with my opinionated structure instead of relying on the OSS community's sensible defaults. These people are smarter than me, and while it may help me understand the libraries I implement, going to route of the defaults feels cleaner.

Requirements

  • Write a PHILOSOPHY.md doc to detail this idea
  • Write a DEFAULTS.md doc to keep track of everything. Going to each website is a pain.
  • Write a CONTRIBUTING.md doc just in case any human interacts with this repo
  • Add husky and lint-staged to ensure linting and prettier are consistent across machines
@cwlsn cwlsn added 🗄️ new dependencies Changes to project dependencies were made. 🏡 housekeeping Updates that don't impact the code, but keep the project running smoothly. 📃 documentation Changes to documentation were made. 🍽️ chore Basic tasks to keep things updated or working correctly. 📜 scripts change A change to any of the scripts in package.json. labels Sep 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🗄️ new dependencies Changes to project dependencies were made. 🏡 housekeeping Updates that don't impact the code, but keep the project running smoothly. 📃 documentation Changes to documentation were made. 🍽️ chore Basic tasks to keep things updated or working correctly. 📜 scripts change A change to any of the scripts in package.json.
Projects
None yet
Development

No branches or pull requests

1 participant