Comments (5)
the readme is really great!
@taveras @pgoldrbx - incase you want to stick to this readme format, I would recommend planning a short intro blog post (for technology.condenast.com) to announce the library and make the case for why someone could use it.
My recommendation to think of the readme/blogpost together was to reduce the amount of documentation to be created for open sourcing a project.
from xml-to-react.
since this issue was created primarily to address one of my recommendations on thinking of the readme like a blog post, we have since moved to using the readme checklist (as listed in #23) for the readme. If there are any recommendations for updating the checklist itself, we should handle that in the open source templates https://github.com/CondeNast/evangelism/tree/master/open-source/templates.
Closing this.
from xml-to-react.
#9 is an excellent start. we'll need to revisit this to make this read similar to a blog post, per @gautamarora 's recommendation
from xml-to-react.
@gautamarora I have no particular thoughts/opinions on README format. I'd love to have some kind of "best practice" guide for READMEs in general, not just for OSS
from xml-to-react.
@pgoldrbx checkout the readme checklist https://github.com/CondeNast/evangelism/blob/master/open-source/templates/CHECKLIST.md#readme-checklist
from xml-to-react.
Related Issues (20)
- add code coverage
- Convert XML nodes to custom elements by default HOT 2
- Deprecate this repository or use atjson internally.
- improve handling of invalid XML documents HOT 2
- Dependency Dashboard
- Allow coercion of XML node attribute values HOT 1
- Create internal interface for XML parsing HOT 1
- add contributing documentation HOT 2
- Open-Source Requirements HOT 2
- Complete Open Source Checklist HOT 9
- Using reduce for better readability in getAttributes
- Using Jest for testing HOT 1
- write tests for helpers HOT 1
- Run build after tests in travis to help prevent breaks
- Action Required: Fix Renovate Configuration
- Dependency deprecation warning: babel (npm)
- Dependency deprecation warning: babel-preset-es2015 (npm)
- Dependency deprecation warning: babel (nvm)
- Dependency deprecation warning: babel-preset-es2015 (nvm)
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 xml-to-react.