Comments (3)
need to define our contributing guidelines, or find an existing example to copy
from starmap.
@SgtPooki any specific examples you want to use?
Here are some that I suggest we can use as inspiration:
- github/docs/CONTRIBUTING.md
- github/opensource.guide/CONTRIBUTING.md
- microsoft/TypeScript/CONTRIBUTING.md
- microsoft/vscode/CONTRIBUTING.md
- kubernetes/kubernetes/CONTRIBUTING.md
TypeScript and vscode are more detailed and have sections specific to coding. They also have wikis for more in-depth guides:
- https://github.com/microsoft/TypeScript/wiki/Contributing-to-TypeScript
- https://github.com/microsoft/vscode/wiki/How-to-Contribute
Another example is Kubernetes' contributing docs, which is very comprehensive. IMO we probably don't need the same governance processes involved in Kubernetes right now, so we can just use it as inspiration and get some pieces here and there that are relevant to our project, but not everything.
from starmap.
I think leaning more into the existing contributing docs for ipfs repos makes the most sense, but those are great for ideas for improvements.
Some existing contributing docs:
- https://github.com/ipfs/ipfs-companion/blob/eeaa0838f920f5a36289818d9f885dcf075ca2e0/docs/CONTRIBUTING.md
- https://github.com/ipfs/community/blob/e0812a37d7a611bbf1f3b37b0bd00c017f98da8f/CONTRIBUTING.md
- https://github.com/ipfs/community/blob/e0812a37d7a611bbf1f3b37b0bd00c017f98da8f/CONTRIBUTING_JS.md
- https://github.com/ipfs/kubo/blob/ef866a1400b3b2861e5e8b6cc9edc8633b890a0a/CONTRIBUTING.md
- https://github.com/ipfs/js-ipfs/blob/6870873f0696bb5d8d91fce4a4ef1f7420443993/packages/ipfs/CONTRIBUTING.md
I think a mix of the following two would be good:
- https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md
- https://github.com/ipfs/js-ipfs/blob/master/CONTRIBUTING.md
from starmap.
Related Issues (20)
- docs: updates to documentation
- Hybrid detailed/overview mode HOT 2
- bug: completion rate is invalid for filecoin-station/roadmap#15 HOT 4
- fix: better prevention and handling of exhausted tokens
- feat: d3-migration - create "legacy" branch and deploy legacy.starmap.site where users can go to for old functionality HOT 2
- Feature request: Notion database integration HOT 6
- bug: no children found on probelab root issue HOT 5
- It's hard to understand the code and contribute HOT 3
- fix: d3-migration - default view finding for ipfs/roadmap#102 HOT 1
- fix: migrate /components/theme/constants.ts to /pages/_app.tsx HOT 1
- fix: d3-migration - breadcrumb navigation HOT 1
- bug: Uncaught (in promise) Error: Unsupported URL: https://github.com/issues/ HOT 3
- fix: d3-migration - track down what's not loading for Molly HOT 1
- bug: panning sends off multiple requests to favicon.ico
- bug: filecoin-station/roadmap#19 has 4 children and is only rendering 1
- feat: improve caching experience HOT 3
- Reference(s) Roadmap? HOT 1
- Cross-repo referencing HOT 3
- feat: /roadmap caching improvements
- No children found error when rendering a root node with tasklist specified
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 starmap.