Skip to content

Commit 4861d3d

Browse files
itowlsonitowlson
committed
Minimal contribution doc and code of conduct
1 parent d9b2372 commit 4861d3d

File tree

4 files changed

+223
-0
lines changed

4 files changed

+223
-0
lines changed

Diff for: ‎CODE_OF_CONDUCT.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
*Note*: this Code of Conduct pertains to individuals' behavior. Please also see the [Organizational Code of Conduct][OCoC].
4+
5+
## Our Pledge
6+
7+
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, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to creating a positive environment include:
12+
13+
* Using welcoming and inclusive language
14+
* Being respectful of differing viewpoints and experiences
15+
* Gracefully accepting constructive criticism
16+
* Focusing on what is best for the community
17+
* Showing empathy towards other community members
18+
19+
Examples of unacceptable behavior by participants include:
20+
21+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
22+
* Trolling, insulting/derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Our Responsibilities
28+
29+
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.
30+
31+
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.
32+
33+
## Scope
34+
35+
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.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Bytecode Alliance CoC team at [[email protected]](mailto:[email protected]). The CoC team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The CoC team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
40+
41+
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 Bytecode Alliance's leadership.
42+
43+
## Attribution
44+
45+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
46+
47+
[OCoC]: https://github.com/bytecodealliance/wasmtime/blob/main/ORG_CODE_OF_CONDUCT.md
48+
[homepage]: https://www.contributor-covenant.org
49+
[version]: https://www.contributor-covenant.org/version/1/4/

Diff for: ‎CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing
2+
3+
The Component Model documentation is a is a [Bytecode Alliance](https://bytecodealliance.org/) project, and follows the Bytecode Alliance's [Code of Conduct](CODE_OF_CONDUCT.md) and [Organizational Code of Conduct](ORG_CODE_OF_CONDUCT.md).
4+
5+
## Getting the Markdown Source
6+
7+
You'll clone the code via git:
8+
9+
```
10+
git clone https://github.com/bytecodealliance/cargo-component
11+
```
12+
13+
## Viewing Changes
14+
15+
Use [mdbook](https://rust-lang.github.io/mdBook/) to view changes locally:
16+
17+
```
18+
cd component-model
19+
mdbook serve
20+
```
21+
22+
## Submitting Changes
23+
24+
Changes to the documentation are managed through pull requests (PRs). Everyone is welcome to submit a pull request! We'll try to get to reviewing it or responding to it in at most a few days.

Diff for: ‎ORG_CODE_OF_CONDUCT.md

+143
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
# Bytecode Alliance Organizational Code of Conduct (OCoC)
2+
3+
*Note*: this Code of Conduct pertains to organizations' behavior. Please also see the [Individual Code of Conduct](CODE_OF_CONDUCT.md).
4+
5+
## Preamble
6+
7+
The Bytecode Alliance (BA) welcomes involvement from organizations,
8+
including commercial organizations. This document is an
9+
*organizational* code of conduct, intended particularly to provide
10+
guidance to commercial organizations. It is distinct from the
11+
[Individual Code of Conduct (ICoC)](CODE_OF_CONDUCT.md), and does not
12+
replace the ICoC. This OCoC applies to any group of people acting in
13+
concert as a BA member or as a participant in BA activities, whether
14+
or not that group is formally incorporated in some jurisdiction.
15+
16+
The code of conduct described below is not a set of rigid rules, and
17+
we did not write it to encompass every conceivable scenario that might
18+
arise. For example, it is theoretically possible there would be times
19+
when asserting patents is in the best interest of the BA community as
20+
a whole. In such instances, consult with the BA, strive for
21+
consensus, and interpret these rules with an intent that is generous
22+
to the community the BA serves.
23+
24+
While we may revise these guidelines from time to time based on
25+
real-world experience, overall they are based on a simple principle:
26+
27+
*Bytecode Alliance members should observe the distinction between
28+
public community functions and private functions — especially
29+
commercial ones — and should ensure that the latter support, or at
30+
least do not harm, the former.*
31+
32+
## Guidelines
33+
34+
* **Do not cause confusion about Wasm standards or interoperability.**
35+
36+
Having an interoperable WebAssembly core is a high priority for
37+
the BA, and members should strive to preserve that core. It is fine
38+
to develop additional non-standard features or APIs, but they
39+
should always be clearly distinguished from the core interoperable
40+
Wasm.
41+
42+
Treat the WebAssembly name and any BA-associated names with
43+
respect, and follow BA trademark and branding guidelines. If you
44+
distribute a customized version of software originally produced by
45+
the BA, or if you build a product or service using BA-derived
46+
software, use names that clearly distinguish your work from the
47+
original. (You should still provide proper attribution to the
48+
original, of course, wherever such attribution would normally be
49+
given.)
50+
51+
Further, do not use the WebAssembly name or BA-associated names in
52+
other public namespaces in ways that could cause confusion, e.g.,
53+
in company names, names of commercial service offerings, domain
54+
names, publicly-visible social media accounts or online service
55+
accounts, etc. It may sometimes be reasonable, however, to
56+
register such a name in a new namespace and then immediately donate
57+
control of that account to the BA, because that would help the project
58+
maintain its identity.
59+
60+
For further guidance, see the BA Trademark and Branding Policy
61+
[TODO: create policy, then insert link].
62+
63+
* **Do not restrict contributors.** If your company requires
64+
employees or contractors to sign non-compete agreements, those
65+
agreements must not prevent people from participating in the BA or
66+
contributing to related projects.
67+
68+
This does not mean that all non-compete agreements are incompatible
69+
with this code of conduct. For example, a company may restrict an
70+
employee's ability to solicit the company's customers. However, an
71+
agreement must not block any form of technical or social
72+
participation in BA activities, including but not limited to the
73+
implementation of particular features.
74+
75+
The accumulation of experience and expertise in individual persons,
76+
who are ultimately free to direct their energy and attention as
77+
they decide, is one of the most important drivers of progress in
78+
open source projects. A company that limits this freedom may hinder
79+
the success of the BA's efforts.
80+
81+
* **Do not use patents as offensive weapons.** If any BA participant
82+
prevents the adoption or development of BA technologies by
83+
asserting its patents, that undermines the purpose of the
84+
coalition. The collaboration fostered by the BA cannot include
85+
members who act to undermine its work.
86+
87+
* **Practice responsible disclosure** for security vulnerabilities.
88+
Use designated, non-public reporting channels to disclose technical
89+
vulnerabilities, and give the project a reasonable period to
90+
respond, remediate, and patch. [TODO: optionally include the
91+
security vulnerability reporting URL here.]
92+
93+
Vulnerability reporters may patch their company's own offerings, as
94+
long as that patching does not significantly delay the reporting of
95+
the vulnerability. Vulnerability information should never be used
96+
for unilateral commercial advantage. Vendors may legitimately
97+
compete on the speed and reliability with which they deploy
98+
security fixes, but withholding vulnerability information damages
99+
everyone in the long run by risking harm to the BA project's
100+
reputation and to the security of all users.
101+
102+
* **Respect the letter and spirit of open source practice.** While
103+
there is not space to list here all possible aspects of standard
104+
open source practice, some examples will help show what we mean:
105+
106+
* Abide by all applicable open source license terms. Do not engage
107+
in copyright violation or misattribution of any kind.
108+
109+
* Do not claim others' ideas or designs as your own.
110+
111+
* When others engage in publicly visible work (e.g., an upcoming
112+
demo that is coordinated in a public issue tracker), do not
113+
unilaterally announce early releases or early demonstrations of
114+
that work ahead of their schedule in order to secure private
115+
advantage (such as marketplace advantage) for yourself.
116+
117+
The BA reserves the right to determine what constitutes good open
118+
source practices and to take action as it deems appropriate to
119+
encourage, and if necessary enforce, such practices.
120+
121+
## Enforcement
122+
123+
Instances of organizational behavior in violation of the OCoC may
124+
be reported by contacting the Bytecode Alliance CoC team at
125+
[[email protected]](mailto:[email protected]). The
126+
CoC team will review and investigate all complaints, and will respond
127+
in a way that it deems appropriate to the circumstances. The CoC team
128+
is obligated to maintain confidentiality with regard to the reporter of
129+
an incident. Further details of specific enforcement policies may be
130+
posted separately.
131+
132+
When the BA deems an organization in violation of this OCoC, the BA
133+
will, at its sole discretion, determine what action to take. The BA
134+
will decide what type, degree, and duration of corrective action is
135+
needed, if any, before a violating organization can be considered for
136+
membership (if it was not already a member) or can have its membership
137+
reinstated (if it was a member and the BA canceled its membership due
138+
to the violation).
139+
140+
In practice, the BA's first approach will be to start a conversation,
141+
with punitive enforcement used only as a last resort. Violations
142+
often turn out to be unintentional and swiftly correctable with all
143+
parties acting in good faith.

Diff for: ‎README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# WebAssembly Component Model Documentation
2+
3+
This repository contains user-facing documentation for the WebAssembly component model. "User-facing" means it focuses on how to use the component model, not on the internal design and implementation details.
4+
5+
It is envisaged to contain two books, one on the component model itself, and one on WASI (WebAssembly System Interface). At the time of writing, the first book is in development, but the second is not yet started.
6+
7+
Contributions are welcome - see [Contributing](./CONTRIBUTING.md) for more info. Planned work is listed in the Issues section, but if there's content missing that you think would be helpful to gain understanding of the component model, please feel free to add a new issue, or send a PR directly!

0 commit comments

Comments
 (0)