commit 3f7a2be1e6d29cc82b4f2c46f850ab20629c900a
parent 0fd5cb7078b74ad050cdeadbe101af3553e7d39f
Author: Gavin <gvnatknsn@gmail.com>
Date: Thu, 1 Aug 2019 10:33:59 -0700
add contribution guidelines, license
Diffstat:
3 files changed, 100 insertions(+), 0 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,78 @@
+# Contributing to Urbit
+
+Thank you for your interest in contributing to Urbit.
+
+
+## Git practice
+
+Since we use the GitHub issue tracker, it is helpful (though not
+required) to contribute via a GitHub pull request. If you already know
+what you are doing, skip down to the Style section.
+
+Start by cloning the repository on your work machine:
+
+```
+$ git clone https://github.com/urbit/ob-js
+```
+
+And, additionally, fork the repository on GitHub by clicking the "Fork"
+button. Add your fork as a remote:
+
+```
+$ git remote add [username] https://github.com/[username]/ob-js
+```
+
+and set it as the default remote to push to:
+
+```
+$ git config --local remote.pushDefault [username]
+```
+
+This is good practice for any project that uses git. You will pull
+upstream branches from urbit/ob-js and push to your personal ob-js fork
+by default.
+
+Next, start a new branch to do your work on. For `ob-js`, please use the
+latest tagged release as your starting point. For other repositories,
+anywhere pointed to by `master` is alright to start from.
+
+```
+$ git checkout -b [branch name] [starting point]
+```
+
+Now you are free to do your work on this branch. When finished, you may
+want to clean up your commits:
+
+```
+$ git rebase -i [starting point]
+```
+
+Then you can push to your public fork with `git push` and make a pull
+request via the GitHub UI.
+
+After your changes are merged upstream, you can delete your branch (via
+github UI or `git push :[branch]` remotely, and with `git branch -d`
+locally).
+
+## Style
+
+We prefer the [AirBnb JS styleguide](https://github.com/airbnb/javascript). At minimum, your code should be simple and well-organized.
+
+
+## What to work on
+
+If you are not thinking of contributing with a specific goal in mind,
+the GitHub issue tracker is the first place you should look for ideas.
+Issues are tagged with a priority and a difficulty. A good place to
+start is on either a low-difficulty issue or a low-priority issue.
+Higher priority issues are likely to be assigned to someone - if this is
+the case, then contacting that person to coordinate before starting to
+work is probably a good idea.
+
+There is also a "help wanted" tag for things that we are especially
+eager to have outside contributions on. Check here first!
+
+## Staying in touch
+
+Questions or other communications about contributing to Urbit can go to
+[support@urbit.org](mailto:support@urbit.org).
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tlon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/package.json b/package.json
@@ -1,6 +1,7 @@
{
"name": "urbit-ob",
"version": "4.0.2",
+ "license": "MIT",
"description": "Utilities for Hoon-style atom printing and conversion",
"main": "src/index.js",
"browser": {
