Comments (5)
rickpeyton
commented on August 23, 2024
2
I think I fall more in line with Christopher on this and that was the path I started going down.
I haven't put in a PR on this, but here is how I set it up.
https://github.com/lampo/ramsey-cop/blob/5aa1d3a19aebb29ef62f5a2fbbef78dd864af541/README.md
Would you be OK if it was done like that @breese524 ? Or still wiki?
from ramsey-cop.
jwsloan
commented on August 23, 2024
1
@rickpeyton I'd say move forward with your PR.
from ramsey-cop.
breese524
commented on August 23, 2024
The readme should have enough info to get someone started using the gem. Then, if you have more detailed docs, I would make a wiki.
from ramsey-cop.
mellowfish
commented on August 23, 2024
I am all for local documentation in it's own directory (with top-level docs linked from main README)
from ramsey-cop.
mellowfish
commented on August 23, 2024
The wikis always fall down at finding what you are looking for, and being able to just search the repo for key phrases would be great.
from ramsey-cop.
Related Issues (11)
- Favor double quotes over single quotes HOT 6
- Indent access modifiers like private. HOT 26
- Layout/ExtraSpacing HOT 16
- Length Metrics/{Block/Class/Method/Module}Length HOT 13
- Discuss: Increase line length HOT 3
- Style/NumericLiterals HOT 8
- Require frozen string literals HOT 20
- Remove "Prefer single-quoted strings inside interpolations." HOT 4
- Discuss adjusting Metrics/MethodLength and Metrics/AbcSize HOT 6
- Add rubocop-rails as a dependancy HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ramsey-cop.