updates environment

d3plus · May 26, 2017 · 464f0c5 · 464f0c5
1 parent 27361ec
commit 464f0c5
Show file tree

Hide file tree

Showing 3 changed files with 156 additions and 0 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,111 @@
+# Contributing
+
+We love Pull Requests from anyone and everyone. To get started, fork the repo, then clone your fork:
+
+```sh
+git clone git@github.com:your-username/d3plus-form.git
+```
+
+## Setting up your Environment
+
+1. Install Node Package Manager (NPM).
+> <sub>If on a Mac, we suggest using [Homebrew](http://brew.sh/) to install packages on your machine. Once that's installed, you can install node (which includes npm) by running: `brew install node`</sub>
+2. Install all repository dependencies:
+```sh
+npm i
+```
+
+And that's it! Now your environment should be all set up and ready to go.
+
+## Writing Code
+
+With the introduction of modules in D3plus 2.0, all code is transpiled using [buble](http://buble.surge.sh/), which allows usage of most of the good bits from ES6. If you are unfamiliar with ES6, then normal vanilla javascript works fine as well (but we may suggest PR revisions to include more succinct ES6). All source code lives in the `./src` directory.
+
+## Code Style
+
+Every d3plus module adheres to the same `.eslintrc` ruleset for javascript syntax. This helps user contribution, as it guarantees a cohesive and easy to read code style throughout every module. The easiest way to follow the style guide is by installing a linter directly in your text editor, so that errors will be highlighted as you type. If your Pull Request does not match the project's linting style, it will not be merged.
+
+## Running the Development Server
+
+To test your code live in a browser, with auto-compiling and hot reloading, type this into your shell:
+
+```sh
+npm run dev
+```
+
+You can then go to `http://localhost:4000/dev/` in your preferred browser to test your code live. Please store all test pages in the hidden `./dev` directory so that they do not get pushed to the repository. Here is a boilerplate HTML file to get your started:
+
+```html
+<script src="../build/d3plus-form.full.js"></script>
+<body>
+
+</body>
+<script>
+
+</script>
+```
+The development server detects any time a source file is modified, and will rebuild the browser javascript package and reload any open browser connections when a change occurs.
+
+## Code Documentation
+
+All of the Documentation you see in the README file is generated auto-magically from the [JSDoc](http://usejsdoc.org/) formatted comments within each source file. This removes the nuisance of having to write documentation after the fact, and enforces strict code commenting. To regenerate the documentation at any time, simply run:
+
+```sh
+npm run docs
+```
+
+> This command is run automatically during the release process.
+
+## Tests
+
+Any time you write a new feature for a module, you should also be writing tests. D3plus modules come bundled with a test suite that let's you write tests using full ES6, which are then run directly in a headless Electron browser.
+
+All tests need to be placed in the `./test` directory, and the filenames should match up to the components in `./src`. To run all tests, run:
+
+```sh
+npm test
+```
+> This command will also lint all files according to the provided `.eslintc` file.
+
+## Examples
+
+All D3plus 2.0 examples seen on [d3plus.org](https://d3plus.org) are created from within their respective repositories. The examples are parsed from any markdown files placed in the `./example` directory, with the following behaviors:
+
+#### Title
+
+Example titles are extracted from the first H1 present in the file. Generally, the first line of the file will be the title:
+
+```md
+# My Cool Example
+```
+
+#### URL Slug
+
+The slug used in the URL on [d3plus.org](https://d3plus.org) is taken directly from the filename. A file with the following path:
+
+```sh
+/example/my-cool-example.md
+```
+
+Would end up at the following URL:
+
+```sh
+https://d3plus.org/examples/d3plus-form/my-cool-example/
+```
+
+#### Code Blocks
+
+Any `css`, `html`, or `js` code block present in an example will be extracted and rendered into a static HTML file. This is what gets used on [d3plus.org](https://d3plus.org), and also let's us take screenshots!
+
+#### Screenshots
+
+A screenshot of each example is generated from the rendered HTML. By default, each screenshot is 990x400 in size, but specific dimensions can be given using markdown relative links:
+
+```md
+[width]: 100
+[height]: 100
+```
+
+## Submitting a Pull Request
+
+Push to your fork and [submit a pull request](https://github.com/d3plus/d3plus-form/compare/). At this point, you're waiting on us. We may suggest some changes or improvements or alternatives.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,27 @@
+<!-- Are you asking for help or have a general question? -->
+<!-- If so, please consider using the D3plus Gitter community. -->
+<!-- https://gitter.im/d3plus/ -->
+
+<!-- Provide a general summary of the issue in the title above. -->
+<!-- Please create separate issues for each individual bug/feature. -->
+
+### Expected Behavior
+<!-- If you're describing a bug, tell us what should happen -->
+<!-- If you're suggesting a change/improvement, tell us how it should work -->
+
+### Current Behavior
+<!-- If describing a bug, tell us what happens instead of the expected behavior -->
+<!-- If suggesting a change/improvement, explain the difference from current behavior -->
+
+### Steps to Reproduce (for bugs)
+<!-- Provide a link to a live example, a screenshot, -->
+<!-- and/or an unambiguous set of steps to reproduce this bug. -->
+1.
+2.
+3.
+
+### Your Environment
+<!-- Include as many relevant details about the environment in which you experienced the bug. -->
+* Browser Name:
+* Operating System and Version:
+
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,18 @@
+<!--- Provide a general summary of your changes in the title above -->
+
+### Description
+<!--- Describe your changes in detail -->
+
+### Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+### Checklist
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] I have documented all new methods.
+- [ ] I have written tests for all new methods/functionality.
+- [ ] I have written examples for all new methods/functionality.
+