-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Feature: Update App Documentation / README #3471
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Obviously still WIP, but welcome any feedback / suggestions at this point. Overally shape of it is largely there, I think.
### Core Frameworks and Libraries | ||
- Ruby on Rails | ||
- Tailwind CSS | ||
- Webpacker / Shakapacker | ||
|
||
### Notable Tools | ||
- ViewComponent | ||
- React | ||
- Sidekiq | ||
- Kramdown | ||
|
||
### Testing and Linting | ||
- RSpec | ||
- Jest | ||
- Rubocop | ||
- Erblint | ||
- ESLint | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seeing it now I feel like this is overkill, at least for the README. Perhaps better suited to the wiki or another doc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can see where you're coming from by feeling it's overkill. I can't think of another spot for it though 😅
There would be no harm in leaving it here imo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about moving it to the CONTRIBUTING file under a new Tech we use
section?
|
||
Created by [Erik Trautman](http://www.github.com/eriktrautman) | ||
## Significant Contributors | ||
_This should be kept, but should it be directly in the README or linked to from here?_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thoughts? Should this be kept as is? Put into significant_contributors.md
and linked to? Something else entirely? There's a few spots where this information is duplicated somewhat, especially with the hall of fame
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have an idea in the backlog for creating a team page which may be a nice replacement/ solution to all this duplication.
GOOGLE_CLIENT_ID: 1234 | ||
GOOGLE_CLIENT_SECRET: 1234 | ||
SPAM_DOMAINS: 'example.com, baddomain.com' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couldn't see this referenced anywhere so took it out.
@ChargrilledChook RE: running all the tests and such from the PR where you mentioned |
Still planning on doing this but need to revisit, many suggestions / changes have been implemented in the Wiki |
Because
WIP. Putting up early To get early feedback on overall direction
This PR
env.sample
Issue
Closes #3470