contributing doc

jlord · Mar 4, 2014 · 7850ee5 · Flint05 · May 10, 2022 · Flint05
1 parent 8fb196e
commit 7850ee5
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/contributing.md b/contributing.md
@@ -0,0 +1,17 @@
+# Contributing to Sheetsee.js
+
+This repository (github/jlord/sheetsee.js) is primarily for documentation and the documentation website. It also contains a copy of a full sheetsee.js (one that includes the map, charts and table portions).
+
+### Use this repository to file issues and pull requests on documentation/documentation site.
+
+The documentation is contained in the `/docs` and `/demos` folders in the root. I build the site (on the `gh-pages` branch) from these files so **submit pull requests against the files in `/docs` and `/demos`** and not the `/site` folder or the `gh-pages` branch.
+
+### For issues and pull requests on the JavaScript, use the repository for the affected portion:
+
+- [sheetsee](http://www.github.com/jlord/sheetsee/issues/new)
+- [sheetsee-core](http://www.github.com/jlord/sheetsee-core/issues/new)
+- [sheetsee-tables](http://www.github.com/jlord/sheetsee-tables/issues/new)
+- [sheetsee-maps](http://www.github.com/jlord/sheetsee-maps/issues/new)
+- [sheetsee-charts](http://www.github.com/jlord/sheetsee-charts/issues/new)
+
+Thank you much! :heart: :octocat:
diff --git a/docs/fork-n-go.md b/docs/fork-n-go.md
@@ -19,7 +19,7 @@ What all of this means is that Sheetsee.js projects, hosted on gh-pages branches
 A Fork-n-Go example from my [blog post](http://jlord.us/fork-n-go/) on the topic:
 
 ### Hack Spots Fork-n-Go
- 
+
 I made this website to collect hack spots all over the world from friends and friends of friends (the spreadsheet is wide open, so you can add some, too!). It’s using sheetsee to power the table, map and other elements of the page. Its source is in this repo, with just a gh-pages branch. To create an instance of this site for yourself all you need to do:
 
 - Create a Google spreadsheet with the same headers (just copy and paste header row from the original). Click File > Publish to Web, then Start Publishing.
@@ -29,4 +29,4 @@ Commit your change.
 
 Now you have the same site connected to a spreadsheet that you manage — it’s live and can be found at yourGitHubName.github.io/theReposName.
 
-![forkcommit](http://jlord.s3.amazonaws.com/wp-content/uploads/forkcommit1.png)
+![forkcommit](http://jlord.s3.amazonaws.com/wp-content/uploads/forkcommit1.png)