Update README and add CODE OF CONDUCT and CONTRIBUTING (#42)

* update README

* add Code of Conduct and Contributing guidlines

* fix typo in CONTRIBUTING

* update README links

* fix the link update

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opensource@openlaw.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,96 @@
+# Contributing to OpenLaw
+
+:+1::tada: First off, thanks for being interested in contributing to OpenLaw! :tada::+1:
+
+The following is a set of guidelines for contributing to OpenLaw and its open-source repositories, which are hosted in the [OpenLaw Organization](https://github.com/openlawteam) on GitHub.
+
+#### Table Of Contents
+
+[Code of Conduct](#code-of-conduct)
+
+[Questions](#questions)
+
+[How Can I Contribute?](#how-can-i-contribute)
+  * [Reporting Bugs](#reporting-bugs)
+  * [Suggesting Enhancements](#suggesting-enhancements)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [OpenLaw Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [opensource@openlaw.io](mailto:opensource@openlaw.io).
+
+## Questions
+
+> **Note:** If you have a question, please don't file an issue. You'll get faster results by using the resource below.
+
+We have a detailed FAQ on our website.
+
+* [OpenLaw FAQ](https://openlaw.io/faq)
+
+We also have an active OpenLaw Community Slack:
+
+* [Join the OpenLaw Community Slack Team](https://join.slack.com/t/openlaw-community/shared_invite/enQtMzY1MTA2ODY3ODg5LTc0ZGQ4OTEwMDEyMGUxMzJmMDVmNzM1ODRmNTdkNDIyNDkyOGU0NmRkMmRlMmY3ZTMwYzNlOTFiMzUwZjJkOTk)
+    * Even though Slack is a chat service, sometimes it takes several hours for OpenLaw team members to respond — however, we'll get to your query as soon as we can! Our team is distributed across timezones and wants to help you.
+    * Use the `#general` channel for general questions or discussion about OpenLaw.
+    * Use the `#bugs` channel for reporting bugs with the OpenLaw application (as distinct from bugs you encounter in running one of our libraries — for those, you should open an issue as discussed [below](#reporting-bugs).
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report for OpenLaw Elements. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
+
+Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report).
+
+> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
+
+#### Before Submitting A Bug Report
+
+* **Reach out to our team on Slack in the `#bugs` channel.**
+* **Perform a [cursory search](https://github.com/openlawteam/openlaw-elements/issues)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
+
+#### How Do I Submit A (Good) Bug Report?
+
+Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/).
+
+When creating an issue, explain the problem and include additional details to help maintainers reproduce the problem:
+
+* **Use a clear and descriptive title** for the issue to identify the problem.
+* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining what you are trying to do with OpenLaw Elements. When listing steps, **don't just say what you did, but explain how you did it**.
+* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
+* **Explain which behavior you expected to see instead and why.**
+* **Include screenshots and videos** which show you following the described steps and clearly demonstrate the problem. We recommend [Loom](useloom.com).
+* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
+
+Provide more context by answering these questions:
+
+* **Did the problem start happening recently** (e.g., after updating to a new version of `openlaw-elements`) or was this always a problem?
+* If the problem started happening recently, **can you reproduce the problem in an older version of `openlaw-elements`?** What's the most recent version in which the problem doesn't happen?
+* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
+
+Include details about your configuration and environment:
+
+* **Which version of the `openlaw-elements` library are you using?**
+* **What's the name and version of the OS you're using**?
+* **Are you running `openlaw-elements` in a virtual machine or Docker container?** Please provide more information about your environment in that case.
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for OpenLaw Elements, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
+
+Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion).
+
+#### Before Submitting An Enhancement Suggestion
+
+* **Perform a [cursory search](https://github.com/openlawteam/openlaw-elements/issues)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+
+#### How Do I Submit A (Good) Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Provide the following information in your issue:
+
+* **Use a clear and descriptive title** for the issue to identify the suggestion.
+* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
+* **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
+* **Include screenshots and videos** which show you following the described steps and clearly demonstrate the problem. We recommend [Loom](useloom.com).
+* **Explain why this enhancement would be useful** to users of OpenLaw Elements.

README.md

@@ -27,10 +27,10 @@ import OpenLawForm from 'openlaw-elements';
 import 'openlaw-elements/dist/openlaw-elements.min.css';
 
 // OpenLaw APIClient: https://docs.openlaw.io/api-client/#authentication
-//  - Used to fetch geo data in our `Address` field type
-//  - To run against your own private OpenLaw instance: 'https://[YOUR.INSTANCE.URL]';
+//  - used to fetch geo data in our `Address` field type
+//  - to run against your own private OpenLaw instance: 'https://[YOUR.INSTANCE.URL]';
 const apiClient = new APIClient('https://app.openlaw.io');
-// we strongly recommend using environment variables, not hard-coded strings.
+// we strongly recommend using environment variables, not hard-coded strings
 apiClient.login('[YOUR_OPENLAW_EMAIL]', '[YOUR_OPENLAW_PASSWORD]');
 
 // https://docs.openlaw.io/openlaw-object/#compiletemplate
@@ -39,9 +39,9 @@ const { compiledTemplate } = Openlaw.compileTemplate('**Name**: [[First Name]] [
 const { executionResult, errorMessage } = Openlaw.execute(compiledTemplate, {}, {});
 // https://docs.openlaw.io/openlaw-object/#getexecutedvariables
 const variables = Openlaw.getExecutedVariables(executionResult, {});
-// typically the parameters object will be updated in
-// an `onChangeFunction` handler (or in a state manager like Redux or MobX)
-// throughout the lifetime of the app
+// typically the parameters object will be updated in state via 
+// an `onChangeFunction` handler (or in a state manager like Redux
+// or MobX) throughout the lifetime of the app
 const parameters = {};
 
 // helpful for logging in development, or throwing exceptions at runtime
@@ -94,40 +94,14 @@ If you'd like to load the styles via an HTML file, you can copy the path (or fil
 If you want to leave out our styles, that's completely OK. We've set up our components with simple classnames so you can target what you need to, easily. Just add your own stylesheet and take a look at what classes and elements you can style. We find the simplest way to prototype can be using browser developer tools.
 
 ## Optional Parameters
-In addition to our regular parameters, we offer support for the following additional parameters.
 
-#### renderSections
-This is a custom renderer for changing the look and feel of sections generated with the Openlaw client.
-```
-renderSections: ({
- children: React.Node,
- section: string,
-}) => React.Node,
-```
-
-#### sectionTransform
-If you need to apply transformations to section data on render, this parameter can be used to do so. The transformed data will be passed to `renderSections`.
-```
-sectionTransform: (any, number) => {},
-```
-
-#### textLikeInputClass
-This will apply a class to all elements that are text-input like including text, email, number, and textarea.
-```
-textLikeInputClass: "any-valid-class",
-```
-
-#### unsectionedTitle
-This will apply the title to generated sections that have none. If an empty string is provided the title will be unset. The dedfault title is "Miscellaneous".
-```
-unsectionedTitle: "My Unsectioned Title",
-```
+In addition to the required parameters, we offer support for additional parameters that will give you more flexibility to apply styles and render custom form sections. You can check out our [OpenLaw Elements docs](https://docs.openlaw.io/openlaw-elements/) for more details.
 
 ## Running the example app
 
 ### Authenticating to the `APIClient`
 
-If you would like to use our Address input type, please authenticate by sending your OpenLaw login details to the `npm start` command:
+If you would like to use our Address or input type, please authenticate by sending your OpenLaw login details to the `npm start` command:
 
 ```
 OPENLAW_EMAIL=alex@email.com OPENLAW_PASSWORD=password npm start
@@ -136,11 +110,13 @@ OPENLAW_EMAIL=alex@email.com OPENLAW_PASSWORD=password npm start
 *NOTE:* If you do not provide credentials, the app will still run, but you will not be able to select an address lookup from the drop-down, nor be able to see the values in the rendered preview HTML.
 
 ### About the app
-The example app (`openlaw-elements/example`) can help you gain ideas and understanding to build your own OpenLaw app in JavaScript and React. In contrast to the example app, the "Usage" section above intentially leaves out more complex behavior to simply illustrate the required dependencies in order to use `<OpenLawForm />` correctly.
+
+The example app (`openlaw-elements/example`) can help you gain ideas and understanding to build your own OpenLaw app in JavaScript and React. In contrast to the example app, the "Usage" section above intentionally leaves out more complex behavior to simply illustrate the required dependencies in order to use `<OpenLawForm />` correctly.
 
 We use Webpack to bundle a small app that changes the app's state tree every time an edit is made to the rendered `<OpenLawForm />`. Additionally, each time you click the `Preview` button, it will generate a preview of what the final document will look like at the top of the webpage.
 
 ### Run
+
 ```
 git clone git@github.com:openlawteam/openlaw-elements.git
 cd openlaw-elements
@@ -158,3 +134,23 @@ npm start
 - [ ] Address input type will be able to be used without the `APIClient`
 - [ ] Ability to choose input labels and/or placeholders. A current workaround is to hide them with your own CSS.
 - [ ] Ability to enable or disable collapsible sections (generated from the template sections)
+
+## Contributing 
+
+See information about contributing [here](https://github.com/openlawteam/openlaw-elements/blob/master/CONTRIBUTING.md).
+
+## License
+
+Copyright 2019 Aaron Wright, David Roon, and ConsenSys AG.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.