Add contributing guidelines

thoughtspile · Dec 27, 2023 · 91f9939 · 91f9939
1 parent 6e6692b
commit 91f9939
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 4 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,28 @@
+# Contributing
+
+Want to contribute to hippotable? That makes me very happy ❤️
+
+Here's how to proceed:
+
+1. See a rough outline of the features we'd like to add in [ROADMAP.md](./ROADMAP.md) — in no particular order.
+2. Please find or create an [issue](https://github.com/thoughtspile/hippotable/issues) before starting the work to make sure nobody's working on the feature already, and to get more context on the problem.
+3. The changes go straight to production, so please take your time to double-check that the code works.
+4. Pull requests should link to the issue (`closes #123`) and contain a brief description of the technical details of your solution.
+5. I might be busy with other things. If the PR gets stuck, please ping [@thoughtspile](https://twitter.com/thoughtspile)
+
+Looking forward to your submissions!
+
+## Development setup
+
+The repo uses a basic node-based setup. To get started, clone the repo and run:
+
+```sh
+npm ci
+npm run dev
+```
+
+Here are a few links to help you give you a head start:
+
+- [AstroJS docs](https://docs.astro.build/en/getting-started/) (Build boilerplate & metaframework)
+- [SolidJS docs](https://www.solidjs.com/docs/latest/api) (UI framework)
+- [Arquero docs](https://uwdata.github.io/arquero/) (dataframe library)
diff --git a/README.md b/README.md
@@ -23,6 +23,18 @@ npm ci
 npm run dev
 ```
 
+## Contributing
+
+See [./CONTRIBUTING.md]
+
+## Acknowledgements
+
+[Arquero](https://github.com/uwdata/arquero) provides the solid dataframe foundation — thanks to [Jeffrey Heer](https://twitter.com/jeffrey_heer) and all the contributors!
+
+[SolidJS](https://github.com/solidjs/solid/) gives us the good developer experience with the performance of vanilla DOM — great work by [Ryan Carniato](https://twitter.com/RyanCarniato) and the team.
+
+Last but not least, [TanStack virtual](https://github.com/TanStack/virtual) by [Tanner Linsley](https://twitter.com/tannerlinsley) gives us powerful table virtualization — and is one of the few projects that support SolidJS.
+
 ## License
 
 [GPLv3 License](./LICENSE)

diff --git a/ROADMAP.md b/ROADMAP.md
@@ -1,9 +1,6 @@
-## Must have
-
-- docs
-
 ## Backlog
 
+- Docs
 - Import
   - JSON import
   - append