Skip to content

Commit 21d3511

Browse files
committed
First commit.
0 parents  commit 21d3511

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+10836
-0
lines changed

.gitignore

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Created by https://www.gitignore.io/api/macos
2+
3+
### macOS ###
4+
# General
5+
.DS_Store
6+
.AppleDouble
7+
.LSOverride
8+
9+
# Icon must end with two \r
10+
Icon
11+
12+
# Thumbnails
13+
._*
14+
15+
# Files that might appear in the root of a volume
16+
.DocumentRevisions-V100
17+
.fseventsd
18+
.Spotlight-V100
19+
.TemporaryItems
20+
.Trashes
21+
.VolumeIcon.icns
22+
.com.apple.timemachine.donotpresent
23+
24+
# Directories potentially created on remote AFP share
25+
.AppleDB
26+
.AppleDesktop
27+
Network Trash Folder
28+
Temporary Items
29+
.apdisk
30+
31+
# End of https://www.gitignore.io/api/macos
32+
33+
# Created by https://www.gitignore.io/api/c
34+
35+
### C ###
36+
# Prerequisites
37+
*.d
38+
39+
# Object files
40+
*.o
41+
*.ko
42+
*.obj
43+
*.elf
44+
45+
# Linker output
46+
*.ilk
47+
*.map
48+
*.exp
49+
50+
# Precompiled Headers
51+
*.gch
52+
*.pch
53+
54+
# Libraries
55+
*.lib
56+
*.a
57+
*.la
58+
*.lo
59+
60+
# Shared objects (inc. Windows DLLs)
61+
*.dll
62+
*.so
63+
*.so.*
64+
*.dylib
65+
66+
# Executables
67+
*.exe
68+
*.out
69+
*.app
70+
*.i*86
71+
*.x86_64
72+
*.hex
73+
74+
# Debug files
75+
*.dSYM/
76+
*.su
77+
*.idb
78+
*.pdb
79+
80+
# Kernel Module Compile Results
81+
*.mod*
82+
*.cmd
83+
.tmp_versions/
84+
modules.order
85+
Module.symvers
86+
Mkfile.old
87+
dkms.conf
88+
89+
# End of https://www.gitignore.io/api/c
90+
91+
*.tar.gz
92+
autom4te.cache
93+
autoscan.log
94+
Makefile
95+
config.log
96+
config.status
97+
configure.scan
98+
config.h

.vscode/launch.json

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
// You may need to install the extension "CodeLLDB" for debugging to work on Macs with Catalina.
6+
"name": "Build and Debug",
7+
"type": "lldb",
8+
"request": "launch",
9+
"program": "${workspaceFolder}/test/test",
10+
"args": [],
11+
"cwd": "${workspaceFolder}/test",
12+
"preLaunchTask": "Build"
13+
}
14+
]
15+
}

.vscode/settings.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"files.associations": {
3+
"Makefile.in": "makefile",
4+
"*.h": "c"
5+
}
6+
}

.vscode/tasks.json

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"label": "Configure",
6+
"type": "shell",
7+
"command": "./configure",
8+
"problemMatcher": []
9+
},
10+
{
11+
"label": "Build",
12+
"type": "shell",
13+
"command": "make all && dsymutil test/test",
14+
"problemMatcher": { "base": "$gcc", "fileLocation": ["relative", "${workspaceRoot}/src"] },
15+
"group": {
16+
"kind": "build",
17+
"isDefault": true
18+
}
19+
},
20+
{
21+
"label": "Test",
22+
"type": "shell",
23+
"command": "make check",
24+
"problemMatcher": { "base": "$gcc", "fileLocation": ["relative", "${workspaceRoot}/src"] },
25+
"group": {
26+
"kind": "test",
27+
"isDefault": true
28+
}
29+
},
30+
{
31+
"label": "Distribution Test",
32+
"type": "shell",
33+
"command": "make distcheck",
34+
"problemMatcher": { "base": "$gcc", "fileLocation": ["relative", "${workspaceRoot}/src"] },
35+
"group": "test"
36+
},
37+
{
38+
"label": "Distribution",
39+
"type": "shell",
40+
"command": "make dist",
41+
"problemMatcher": { "base": "$gcc", "fileLocation": ["relative", "${workspaceRoot}/src"] }
42+
},
43+
{
44+
"label": "Distribution Clean",
45+
"type": "shell",
46+
"command": "make distclean",
47+
"problemMatcher": []
48+
},
49+
{
50+
"label": "Clean",
51+
"type": "shell",
52+
"command": "make clean",
53+
"problemMatcher": []
54+
},
55+
{
56+
"label": "Install",
57+
"type": "shell",
58+
"command": "sudo make install",
59+
"problemMatcher": { "base": "$gcc", "fileLocation": ["relative", "${workspaceRoot}/src"] }
60+
},
61+
{
62+
"label": "Uninstall",
63+
"type": "shell",
64+
"command": "sudo make uninstall",
65+
"problemMatcher": { "base": "$gcc", "fileLocation": ["relative", "${workspaceRoot}/src"] }
66+
}
67+
]
68+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
-----BEGIN PGP SIGNED MESSAGE-----
2+
Hash: SHA512
3+
4+
# Contributor License Agreement
5+
6+
Version 1.0
7+
8+
Name: Wolf McNally
9+
10+
11+
12+
Legal Jurisdiction: Wyoming, United States of America
13+
14+
Project: https://github.com/BlockchainCommons/bc-ur
15+
16+
Date: July 30, 2020
17+
18+
## Purpose
19+
20+
This agreement gives Blockchain Commons, LLC the permission it needs in order to accept my contributions into its open software project and to manage the intellectual property in that project over time.
21+
22+
## License
23+
24+
I hereby license Blockchain Commons, LLC to:
25+
26+
1. do anything with my contributions that would otherwise infringe my copyright in them
27+
28+
2. do anything with my contributions that would otherwise infringe patents that I can or become able to license
29+
30+
3. sublicense these rights to others on any terms they like
31+
32+
## Reliability
33+
34+
I understand that Blockchain Commons will rely on this license. I may not revoke this license.
35+
36+
## Awareness
37+
38+
I promise that I am familiar with legal rules, like ["work made for hire" rules](http://worksmadeforhire.com), that can give employers and clients ownership of intellectual property in work that I do. I am also aware that legal agreements I might sign, like confidential information and invention assignment agreements, will usually give ownership of intellectual property in my work to employers, clients, and companies that I found. If someone else owns intellectual property in my work, I need their permission to license it.
39+
40+
## Copyright Guarantee
41+
42+
I promise not to offer contributions to the project that contain copyrighted work that I do not have legally binding permission to contribute under these terms. When I offer a contribution with permission, I promise to document in the contribution who owns copyright in what work, and how they gave permission to contribute it. If I later become aware that one of my contributions may have copyrighted work of others that I did not have permission to contribute, I will notify Blockchain Commons, in confidence, immediately.
43+
44+
## Patent Guarantee
45+
46+
I promise not to offer contributions to the project that I know infringe patents of others that I do not have permission to contribute under these terms.
47+
48+
## Open Source Guarantee
49+
50+
I promise not to offer contributions that contain or depend on the work of others, unless that work is available under a license that [Blue Oak Council rates bronze or better](https://blueoakconcil.org/list), such as the MIT License, two- or three-clause BSD License, the Apache License Version 2.0, or the Blue Oak Model License 1.0.0. When I offer a contribution containing or depending on others' work, I promise to document in the contribution who licenses that work, along with copies of their license terms.
51+
52+
## Disclaimers
53+
54+
***As far as the law allows, my contributions come as is, without any warranty or condition. Other than under [Copyright Guarantee](#copyright-guarantee), [Patent Guarantee](#patent-guarantee), or [Open Source Guarantee](#open-source-guarantee), I will not be liable to anyone for any damages related to my contributions or this contributor license agreement, under any kind of legal claim.***
55+
-----BEGIN PGP SIGNATURE-----
56+
Comment: GPGTools - https://gpgtools.org
57+
58+
iQIzBAEBCgAdFiEElDZS7jhEF2DD3DU2S2wvz4lHgK4FAl8ktlIACgkQS2wvz4lH
59+
gK6ohg/9HJd+ZbI2JWE+lgtLPi4IVGLSw2JqS815sb/ykd3IIJs1JMbGMwV9pd1O
60+
61b6atbr7i/nqlYKakttdZysURj5UNAG9Y+SaNGOBaXlRO4ZqkRBEJdcVauzZOP7
61+
IdIe9PXDvEmpgH1r6HYSzv5BJBptCn9YEbeetbIraaSQSejDBOpgG9b7eLT89lU3
62+
ud+fWNBVo0v3V2Za4/p6s6QcEf4ZfP21oYY3b7XO4Y3JY9KObfhFJzf14uz8Rsvc
63+
lEdbScj2Klm+57zybgw9mamVQCGb/2ffqWn18OqlHBNEObjYy//OBY6FJ9/8/XRg
64+
/Yn4udTQmMWJPVwysQBtfsx/kfImURlqwCQGoZgZDj7Vo7r34WDMi1Hrb6wL/wco
65+
T7yk9F87fCh+/o6pQg7GpaSt7nAaYvmWI6Zmtq55zYJXxHuSbR5tWUrycml/0C76
66+
jKTGd5MEHQZ8mGai9Z/6kFg32VGzwx8YQiHtPsyXQ842aB/QPTLw4Wn2E0TyhAQE
67+
KnNRTfaGTs12PijnL/TZogm1sp7nVSYx88OiyPl7VGCu+rnOc43NfV+/H2vzU7Y2
68+
eJIoJZVfBRKc7t23RrjYnRXE8bQxUfdA0J0/SvshAsXBSgtphRJYdjcb19QCNZjR
69+
KOJjlPXcuqVJslPgI4lqoeLFOooU+edu+CVzy9GVJ0psvXBIOnc=
70+
=irDI
71+
-----END PGP SIGNATURE-----

CLA.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributor License Agreement
2+
3+
Version 1.0
4+
5+
Name: `$name`
6+
7+
E-Mail: `$email`
8+
9+
Legal Jurisdiction: Wyoming, United States of America
10+
11+
Project: https://github.com/BlockchainCommons/bc-ur
12+
13+
Date: `$date`
14+
15+
## Purpose
16+
17+
This agreement gives Blockchain Commons, LLC the permission it needs in order to accept my contributions into its open software project and to manage the intellectual property in that project over time.
18+
19+
## License
20+
21+
I hereby license Blockchain Commons, LLC to:
22+
23+
1. do anything with my contributions that would otherwise infringe my copyright in them
24+
25+
2. do anything with my contributions that would otherwise infringe patents that I can or become able to license
26+
27+
3. sublicense these rights to others on any terms they like
28+
29+
## Reliability
30+
31+
I understand that Blockchain Commons will rely on this license. I may not revoke this license.
32+
33+
## Awareness
34+
35+
I promise that I am familiar with legal rules, like ["work made for hire" rules](http://worksmadeforhire.com), that can give employers and clients ownership of intellectual property in work that I do. I am also aware that legal agreements I might sign, like confidential information and invention assignment agreements, will usually give ownership of intellectual property in my work to employers, clients, and companies that I found. If someone else owns intellectual property in my work, I need their permission to license it.
36+
37+
## Copyright Guarantee
38+
39+
I promise not to offer contributions to the project that contain copyrighted work that I do not have legally binding permission to contribute under these terms. When I offer a contribution with permission, I promise to document in the contribution who owns copyright in what work, and how they gave permission to contribute it. If I later become aware that one of my contributions may have copyrighted work of others that I did not have permission to contribute, I will notify Blockchain Commons, in confidence, immediately.
40+
41+
## Patent Guarantee
42+
43+
I promise not to offer contributions to the project that I know infringe patents of others that I do not have permission to contribute under these terms.
44+
45+
## Open Source Guarantee
46+
47+
I promise not to offer contributions that contain or depend on the work of others, unless that work is available under a license that [Blue Oak Council rates bronze or better](https://blueoakconcil.org/list), such as the MIT License, two- or three-clause BSD License, the Apache License Version 2.0, or the Blue Oak Model License 1.0.0. When I offer a contribution containing or depending on others' work, I promise to document in the contribution who licenses that work, along with copies of their license terms.
48+
49+
## Disclaimers
50+
51+
***As far as the law allows, my contributions come as is, without any warranty or condition. Other than under [Copyright Guarantee](#copyright-guarantee), [Patent Guarantee](#patent-guarantee), or [Open Source Guarantee](#open-source-guarantee), I will not be liable to anyone for any damages related to my contributions or this contributor license agreement, under any kind of legal claim.***
52+
53+
---
54+
55+
To sign this Contributor License Agreement, fill in `$name`, `$email`, and `$date` above. Then sign using GPG using the following command `gpg --armor --clearsign --output cla.YOURGITHUBNAME.YOURGPGFINGERPRINT.asc CLA.md`, then either submit your signed Contributor License Agreement to this repo as a GPG signed Pull Request or email it to [[email protected]](mailto:[email protected]).

CODEOWNERS

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These owners will be the default owners for everything in this repo.
2+
3+
* @ChristopherA @wolfmcnally

CONTRIBUTING.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributing
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## We Develop with Github
12+
We use GitHub to host code, to track issues and feature requests, as well as accept Pull Requests.
13+
14+
## Report bugs using Github's [issues](https://github.com/blockchaincommons/bc-ur/issues)
15+
We use GitHub issues to track public bugs.
16+
17+
If you find bugs, mistakes, inconsistencies in this project's code or documents, please let us know by [opening a new issue](./issues), but consider searching through existing issues first to check and see if the problem has already been reported. If it has, it never hurts to add a quick "+1" or "I have this problem too". This helps prioritize the most common problems and requests.
18+
19+
## Write bug reports with detail, background, and sample code
20+
[This is an example](http://stackoverflow.com/q/12488905/180626) of a good bug report by @briandk. Here's [another example from craig.hockenberry](http://www.openradar.me/11905408).
21+
22+
**Great Bug Reports** tend to have:
23+
24+
- A quick summary and/or background
25+
- Steps to reproduce
26+
- Be specific!
27+
- Give sample code if you can. [The stackoverflow bug report](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing
28+
- What you expected would happen
29+
- What actually happens
30+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
31+
32+
People *love* thorough bug reports. I'm not even kidding.
33+
34+
## Submitting code changes through Pull Requests
35+
36+
Simple Pull Requests to fix typos, document, or fix small bugs are always welcome.
37+
38+
We ask that more significant improvements to the project be first proposed before anybody starts to code as an [issue](./issues) or as a [draft Pull Request](./pulls) (GitHub has a nice new feature for simple Pull Requests called [Draft Pull Requests](https://github.blog/2019-02-14-introducing-draft-pull-requests/). This gives other contributors a chance to point you in the right direction, give feedback on the design, and maybe point out if related work is already under way.
39+
40+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
41+
Pull Requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your Pull Requests:
42+
43+
1. Fork the repo and create your branch from `master`.
44+
2. If you've added code that should be tested, add tests.
45+
3. If you've changed APIs, update the documentation.
46+
4. Ensure the test suite passes.
47+
5. Make sure your code lints.
48+
6. Issue that Pull Request!
49+
50+
## Any code contributions you make will be under the BSD-2-Clause Plus Patent License
51+
In short, when you submit code changes, your submissions are understood will be available under the same [BSD-2-Clause Plus Patent License](./LICENSE.md) that covers the project. We also ask all code contributors to GPG sign the [Contributor License Agreement (CLA.md)](./CLA.md) to protect future users of this project. Feel free to contact the maintainers if that's a concern.
52+
53+
## Use a Consistent Coding Style
54+
* We indent using two spaces (soft tabs)
55+
* We ALWAYS put spaces after list items and method parameters ([1, 2, 3], not [1,2,3]), around operators (x += 1, not x+=1), and around hash arrows.
56+
* This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
57+
58+
## References
59+
60+
Portions of this CONTRIBUTING.md document were adopted from best practices of a number of open source projects, including:
61+
* [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
62+
* [IPFS Contributing](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

0 commit comments

Comments
 (0)