Skip to content

Commit a436432

Browse files
orodioorodio
committed
OPS -- [root] OSS documents
1 parent a1e42f5 commit a436432

File tree

6 files changed

+385
-0
lines changed

6 files changed

+385
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
3+
name: Bug report
4+
about: Create a report to help us improve
5+
title: ""
6+
labels: bug
7+
assignees: 10thfloor
8+
---**Describe the bug**
9+
A clear and concise description of what the bug is.
10+
11+
**To Reproduce**
12+
Steps to reproduce the behavior:
13+
14+
**Expected behavior**
15+
A clear and concise description of what you expected to happen.
16+
17+
**Screenshots**
18+
If applicable, add screenshots to help explain your problem.
19+
20+
**Desktop (please complete the following information):**
21+
22+
- OS: [e.g. iOS]
23+
- Browser [e.g. chrome, safari]
24+
- Version [e.g. 1.0.0]
25+
26+
**Additional context**
27+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ""
5+
labels: enhancement
6+
assignees: 10thfloor
7+
---**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

‎CODE_OF_CONDUCT.md

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at <[email protected]>.
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series
85+
of actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or
92+
permanent ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within
112+
the community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.0, available at
118+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
120+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
121+
enforcement ladder](https://github.com/mozilla/diversity).
122+
123+
[homepage]: https://www.contributor-covenant.org
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
https://www.contributor-covenant.org/faq. Translations are available at
127+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

+138
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
# Contributing to FCL and the Flow JS SDK
2+
3+
The following is a set of guidelines for contributing to FCL and the Flow JS SDK
4+
These are mostly guidelines, not rules.
5+
Use your best judgment, and feel free to propose changes to this document in a pull request.
6+
7+
## Table Of Contents
8+
9+
[Getting Started](#project-overview)
10+
11+
[How Can I Contribute?](#how-can-i-contribute)
12+
13+
- [Reporting Bugs](#reporting-bugs)
14+
- [Suggesting Enhancements](#suggesting-enhancements)
15+
- [Your First Code Contribution](#your-first-code-contribution)
16+
- [Pull Requests](#pull-requests)
17+
18+
[Styleguides](#styleguides)
19+
20+
- [Git Commit Messages](#git-commit-messages)
21+
- [JavaScript Styleguide](#javascript-styleguide)
22+
23+
[Additional Notes](#additional-notes)
24+
25+
## How Can I Contribute?
26+
27+
### Reporting Bugs
28+
29+
#### Before Submitting A Bug Report
30+
31+
- **Search existing issues** to see if the problem has already been reported.
32+
If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
33+
34+
#### How Do I Submit A (Good) Bug Report?
35+
36+
Explain the problem and include additional details to help maintainers reproduce the problem:
37+
38+
- **Use a clear and descriptive title** for the issue to identify the problem.
39+
- **Describe the exact steps which reproduce the problem** in as many details as possible.
40+
When listing steps, **don't just say what you did, but explain how you did it**.
41+
- **Provide specific examples to demonstrate the steps**.
42+
Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
43+
If you're providing snippets in the issue,
44+
use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
45+
- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
46+
- **Explain which behavior you expected to see instead and why.**
47+
- **Include error messages and stack traces** which show the output / crash and clearly demonstrate the problem.
48+
49+
Provide more context by answering these questions:
50+
51+
- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens
52+
and under which conditions it normally happens.
53+
54+
Include details about your configuration and environment:
55+
56+
- **What is the version of the Cadence you're using**?
57+
- **What's the name and version of the Operating System you're using**?
58+
59+
### Suggesting Enhancements
60+
61+
#### Before Submitting An Enhancement Suggestion
62+
63+
- **Perform a cursory search** to see if the enhancement has already been suggested.
64+
If it has, add a comment to the existing issue instead of opening a new one.
65+
66+
#### How Do I Submit A (Good) Enhancement Suggestion?
67+
68+
Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/).
69+
Create an issue and provide the following information:
70+
71+
- **Use a clear and descriptive title** for the issue to identify the suggestion.
72+
- **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
73+
- **Provide specific examples to demonstrate the steps**.
74+
Include copy/pasteable snippets which you use in those examples,
75+
as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
76+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
77+
- **Explain why this enhancement would be useful** to Cadence users.
78+
79+
### Your First Code Contribution
80+
81+
Unsure where to begin contributing to Cadence?
82+
You can start by looking through these `good-first-issue` and `help-wanted` issues:
83+
84+
- [Good first issues][https://github.com/onflow/cadence/labels/good%20first%20issue]:
85+
issues which should only require a few lines of code, and a test or two.
86+
- [Help wanted issues][https://github.com/onflow/cadence/labels/help%20wanted]:
87+
issues which should be a bit more involved than `good-first-issue` issues.
88+
89+
Both issue lists are sorted by total number of comments.
90+
While not perfect, number of comments is a reasonable proxy for impact a given change will have.
91+
92+
### Pull Requests
93+
94+
The process described here has several goals:
95+
96+
- Maintain code quality
97+
- Fix problems that are important to users
98+
- Engage the community in working toward the best possible Developer/User Experience
99+
- Enable a sustainable system for the Cadence's maintainers to review contributions
100+
101+
Please follow the [styleguides](#styleguides) to have your contribution considered by the maintainers.
102+
Reviewer(s) may ask you to complete additional design work, tests,
103+
or other changes before your pull request can be ultimately accepted.
104+
105+
## Styleguides
106+
107+
### Git Commit Messages
108+
109+
- Use the present tense ("Add feature" not "Added feature")
110+
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
111+
- Limit the first line to 72 characters or less
112+
- Reference issues and pull requests liberally after the first line
113+
- Start commits with a 3 character topic
114+
- Topics:
115+
- PKG -- Modified a package (Requires a Changelog Entry)
116+
- DOC -- Modified a some form of documentation
117+
- OPS -- Modified repository tooling/scripts
118+
- VSN -- Changed a version number
119+
- Scope commits to individual packages and include package name in commit message
120+
121+
Format: TOPIC -- [package-name] what is change
122+
123+
Examples:
124+
125+
- OPS -- [root] tests only run once now for ci master branch
126+
- PKG -- [decode] fix issue with using regex for type matching
127+
- DOC -- [root] update readme with emulator instructions
128+
- VSN -- [interaction] 0.0.3 -> 0.0.4
129+
- VSN -- [fcl] 1.5.3 -> 2.0.0 breaking change
130+
- VSN -- [sdk] @onflow/send 0.0.5 -> 0.0.6
131+
132+
### JavaScript Styleguide
133+
134+
Use Prettier with the setting in the root `.prettierrc` file
135+
136+
## Additional Notes
137+
138+
Thank you for your interest in contributing to the FCL and Flow JS SDK

‎NOTICE

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Flow
2+
Copyright 2019-2020 Dapper Labs, Inc.
3+
4+
This product includes software developed at Dapper Labs, Inc. (https://www.dapperlabs.com/).

‎SECURITY.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Security Policy
2+
3+
Flow was built from the ground up with security in mind.
4+
Our code, infrastructure, and development methodology helps us keep our users safe.
5+
6+
We really appreciate the community's help.
7+
Responsible disclosure of vulnerabilities helps to maintain the security and privacy of everyone.
8+
9+
If you care about making a difference, please follow the guidelines below.
10+
11+
## Reporting a Vulnerability
12+
13+
Reports are welcome! Please definitely reach out to us if you have a security concern.
14+
15+
If you believe you may have found a security vulnerability in our project,
16+
to be on the safe side, **do NOT open a public issue**.
17+
18+
Rather, we prefer you to please send us an email: **[email protected]**
19+
20+
To encrypt messages to us, we encourage you to use our PGP key:
21+
22+
-----BEGIN PGP PUBLIC KEY BLOCK-----
23+
mQINBF1J1mABEADX/mVq3Fn1/7+V/fc5UMOlShtQ0n3lTxUkYsKHsQIp4IuDrCZy
24+
XbHayQ9DaoLPOQtXqG0Vosz/KuxQyW5GQ0dL/DwCs+23BAV8ZpTxHQ3RFIfYfjXk
25+
GYS1/aJ0U0TqrdUAkRC2In8YUmWbUZuPI6qJCbtPg+EIJ/3516R23t8UePhSGQ1r
26+
sqTbKg9VaiZkeMNSk07WxqBaC5nUeK94rKEmv+fOwEd/0Ky74s92DDRmaYzfRhaf
27+
FJfIwDTgvZcOIq9iBiLqWnGq7+/uBnJeXwzF6+6+BrR1K9UniTizmuybeyRP2xhO
28+
x1fR0r1Hkcqo5gaPkFzftOr32bS1RENGm8+M7oTJwStnYde/+ynMULrLrgbyPjkx
29+
FX4s8pefuXM7oW4jP+HFjiaqI6LI6t6j4fRwHxPTR4tfpuVJ24hH2oA6A9tDr6d8
30+
MnmYKvSwVTGwkOEFQtLBmxHIc+iNnsBcrpQlQm6MnENGb2MP4lLW/kJnENLXetSx
31+
YIapjpMH7SOqU1fFqDRL7UlTt/DeUFjUeX1dsmJ0PsqLbYEgTFOZFypQ+bU4/nxw
32+
LOygalLo/qGVWrCGz9Of6PNeJMby1mRKBbkgETnujM/k3sNC0NzgUIeq83ONqtVw
33+
RGHYXjz2au9AEb3SLG/ErwYF5L/xVHB20V1+/ddSPNR57zfxO5h18EHAcQARAQAB
34+
tC5EYXBwZXIgTGFicyBTZWN1cml0eSA8c2VjdXJpdHlAZGFwcGVybGFicy5jb20+
35+
iQJUBBMBCAA+FiEEk9NxmWaCVPBVVvQjtLdTxkDR//wFAl1J1mACGwMFCQeGH4AF
36+
CwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQtLdTxkDR//w7YRAAzD8P8qVzd00W
37+
HEAd/Aig7FugHiYqXucyFnC1TPGzUhhRW/wEc4kz9BTN5SNhYlR5ksUARNdisRTX
38+
mCqU0Y6I/PVaO5PITqGvx25NcS4sYzIGMlqpzI6y0dMTpJWh3jcfwwlm3W7aUAeW
39+
32NNxpUH50OAm9p5wxCAErBF0PFznNC6Q/tgvQT1Q+nCp+qSC8h+4axfincJ1EIc
40+
/N9AyOhnMSFGFeDHFF2Q1k75qpychtQ0NA1m6mVjoh0WrRdWYCBCRZ+TKKCGjkOC
41+
Xyg7SFxjIG0b7t0fqfDItIgEJqcCgGiXzcUSmWpi9ePNAoW+U/GF3FMG6hBI7b5R
42+
JMt347Di/ckbfEuftTI/GkQH9FSAZ35ncGRf+D5+ssJ1R7T9dQB0aEptq/IpJx8n
43+
5VDeL0IufyagxK0oLnUtS8qhwqUbX7N1xLEH1zGwDWYwXd+2iTHNxGwhDqBeu1z9
44+
8w0a5mZLJb2P9MeLccm1dy67XlFpZgyg9WIJvgNmpDdUO9481ceoRDXW9ymkiBYK
45+
SR65ZCsbQhsL7CG3alkyFDwTQvkGMDFPPMTMclZ+L/st8QEGTJdJFIhvE9xEpJ9a
46+
K8hR3qUdhlwClRFgiRcyRO+l9pbVe9/QesW5vL/rl6kUviXuVP/kkMT4JJpaE0Ws
47+
DggK02TvyuBs6bT4HMnC0SZggYYbFfu5Ag0EXUnWYAEQAMOPTBRefH/OzdGOdEJe
48+
V0lU5r4nR+o4eD2+KRb1ex00mFaTGMjWTpnwIEKe+wfljvY+P7WE/jp5KNUE1/Ld
49+
4ZH39NvSyXiZV4zHNjgL3ug3vwK4KekdMPdRC7faNG17/g1rhcjctBQyx9Ztb4qT
50+
JlDipYPCBxYM9N07Z4ZUfdh73AtM466Y99yW5zFcConLzpX9+gkuHwQwGRyWjrHS
51+
ydd60sWjRd1O0O4NWmL9C0bNy8opL0js6uI8hqks6txx6CR5VM41C9tscv6EL+4L
52+
vGy36qdHNGYPo/KD4BW3q1n911mLHLlOVZK35PafRnOy/Wg0JEU/riiirkBbSoAo
53+
NeSk/iEnWos/IL0mnBeORFhfZEddrO9lCfBH3m1cBCaphcnlYEyM02ddYqY5Q9AE
54+
tNDbsMjkwvn48EVe5qjSJHSzafYjo7vypEyk0y1SoVM9OcF8IDroEIQ7atCPwgXb
55+
EaIk2VCP6iresVG9LFn0WESeO3wxbRYmn+HlWIPfFcOGYoJ0vJOGhol9Vd23J74+
56+
SMD69Uf+duGAy2nsaN5fFGhUuNS1SAlFPCUJ5tdwyYsoTtsw8J8CU/N0HEbsvAej
57+
SxKNGpGHlMZO9OeM1x8SMhDWrdaVIlAExWbxT24CACYmIa6yoaNygJfqZxuH7rXD
58+
Yvv+fUJbdX/ZZuPuRAPzHTH5ABEBAAGJAjwEGAEIACYWIQST03GZZoJU8FVW9CO0
59+
t1PGQNH//AUCXUnWYAIbDAUJB4YfgAAKCRC0t1PGQNH//ID9EADGcbXzRypfyEBq
60+
PUyoA7qHkKQyAv3r/PVmsKo0gPufi1vlTiCsGCx7cKclxGC/7W8doXSNddLp8+Qq
61+
eIUu323ncD7JCabHp2r5Fa+9G+6aeoF5PJgIQGrgxSrlyg8LR+pAXLfuObC7ruDE
62+
a5xQ3yt1fJUfjJZJJpus+Jwz54As9pAsX0hgflAY/2zN2gPUW4OqBwZpykdyfUbU
63+
KgyqKXvWs/d5YhYjD6C+33k/j+jhkmTvc97FEfu3rrAo8rzX5wVY+Qr4stV44LYh
64+
FbLF2bLlZ/292Q7erdt9GSoxwJ1TwW8CuefkNvsjB+FE6mMe0U+7IKejY8OMIb2i
65+
1oD7LTygqmUGbjwNPzNAjh2aaH5er+LHkpETIoPH1we/rxqCWN725J3vALN48xTC
66+
RRvvVHF0f5SKx3xt6Jkc2s7PcOcnqtdv1LGZ0XOLtrE1GMF54+M4Y3RnJHZ7oQaR
67+
wYz2Jcf5rrHUNfEwcR8tW2xkWCn7JI9L/QHlCTZIAB3yvxL+eVSMb8ATN51ONins
68+
YOXSfgZ2Ag3Ef2WfMRmXYVE+fRelz+EuvfAirxxH5Xz41zg843eXrQBIA2hfHH/O
69+
JzzM+MXfvr96TuBQO40fIBb8Vb5AY/I+ICVSBnH4D9d43k9Hp3dyJdFabg8stEQ7
70+
hfVklUOf8O2ZoQZLML11OKkZWXxSMg==
71+
=HvU0
72+
-----END PGP PUBLIC KEY BLOCK-----

0 commit comments

Comments
 (0)