Skip to content
This repository was archived by the owner on Oct 8, 2025. It is now read-only.

Commit 89b20ca

Browse files
committed
Convert docs to reStructuredText
... it's just better than markdown. Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
1 parent 87a97eb commit 89b20ca

File tree

12 files changed

+3424
-3169
lines changed

12 files changed

+3424
-3169
lines changed

API-C.md

Lines changed: 0 additions & 1174 deletions
This file was deleted.

API-C.rst

Lines changed: 1274 additions & 0 deletions
Large diffs are not rendered by default.

API-Rust.md

Lines changed: 0 additions & 1138 deletions
This file was deleted.

API-Rust.rst

Lines changed: 1238 additions & 0 deletions
Large diffs are not rendered by default.

CODE_OF_CONDUCT.md

Lines changed: 0 additions & 74 deletions
This file was deleted.

CODE_OF_CONDUCT.rst

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
Contributor Covenant Code of Conduct
2+
====================================
3+
4+
Our Pledge
5+
----------
6+
7+
In the interest of fostering an open and welcoming environment, we as
8+
contributors and maintainers pledge to making participation in our
9+
project and our community a harassment-free experience for everyone,
10+
regardless of age, body size, disability, ethnicity, sex
11+
characteristics, gender identity and expression, level of experience,
12+
education, socio-economic status, nationality, personal appearance,
13+
race, religion, or sexual identity and orientation.
14+
15+
Our Standards
16+
-------------
17+
18+
Examples of behavior that contributes to creating a positive environment
19+
include:
20+
21+
- Using welcoming and inclusive language
22+
- Being respectful of differing viewpoints and experiences
23+
- Gracefully accepting constructive criticism
24+
- Focusing on what is best for the community
25+
- Showing empathy towards other community members
26+
27+
Examples of unacceptable behavior by participants include:
28+
29+
- The use of sexualized language or imagery and unwelcome sexual
30+
attention or advances
31+
- Trolling, insulting/derogatory comments, and personal or political
32+
attacks
33+
- Public or private harassment
34+
- Publishing others’ private information, such as a physical or
35+
electronic address, without explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
Our Responsibilities
40+
--------------------
41+
42+
Project maintainers are responsible for clarifying the standards of
43+
acceptable behavior and are expected to take appropriate and fair
44+
corrective action in response to any instances of unacceptable behavior.
45+
46+
Project maintainers have the right and responsibility to remove, edit,
47+
or reject comments, commits, code, wiki edits, issues, and other
48+
contributions that are not aligned to this Code of Conduct, or to ban
49+
temporarily or permanently any contributor for other behaviors that they
50+
deem inappropriate, threatening, offensive, or harmful.
51+
52+
Scope
53+
-----
54+
55+
This Code of Conduct applies both within project spaces and in public
56+
spaces when an individual is representing the project or its community.
57+
Examples of representing a project or community include using an
58+
official project e-mail address, posting via an official social media
59+
account, or acting as an appointed representative at an online or
60+
offline event. Representation of a project may be further defined and
61+
clarified by project maintainers.
62+
63+
Enforcement
64+
-----------
65+
66+
Instances of abusive, harassing, or otherwise unacceptable behavior may
67+
be reported by contacting the moderation team at
68+
nginx-oss-community@f5.com. All complaints will be reviewed and
69+
investigated and will result in a response that is deemed necessary and
70+
appropriate to the circumstances. The project team is obligated to
71+
maintain confidentiality with regard to the reporter of an incident.
72+
Further details of specific enforcement policies may be posted
73+
separately.
74+
75+
Project maintainers who do not follow or enforce the Code of Conduct in
76+
good faith may face temporary or permanent repercussions as determined
77+
by other members of the project’s leadership.
78+
79+
Attribution
80+
-----------
81+
82+
This Code of Conduct is adapted from the `Contributor
83+
Covenant <https://www.contributor-covenant.org>`__, version 1.4,
84+
available at
85+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
86+
87+
For answers to common questions about this code of conduct, see
88+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 0 additions & 83 deletions
This file was deleted.

CONTRIBUTING.rst

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
Contributing Guidelines
2+
=======================
3+
4+
The following is a set of guidelines for contributing to unit-wasm. We
5+
do appreciate that you are considering contributing!
6+
7+
Table Of Contents
8+
-----------------
9+
10+
- `Getting Started <#getting-started>`__
11+
- `Ask a Question <#ask-a-question>`__
12+
- `Contributing <#contributing>`__
13+
- `Git Style Guide <#git-style-guide>`__
14+
15+
Getting Started
16+
---------------
17+
18+
Check out the `README <README.md>`__.
19+
20+
Ask a Question
21+
--------------
22+
23+
Please open an `issue <https://github.com/nginx/unit-wasm/issues/new>`__
24+
on GitHub with the label ``question``. You can also ask a question on
25+
`Slack <https://nginxcommunity.slack.com>`__ or the NGINX Unit mailing
26+
list, unit@nginx.org (subscribe
27+
`here <https://mailman.nginx.org/mailman3/lists/unit.nginx.org/>`__).
28+
29+
Contributing
30+
------------
31+
32+
Report a Bug
33+
~~~~~~~~~~~~
34+
35+
Ensure the bug was not already reported by searching on GitHub under
36+
`Issues <https://github.com/nginx/unit-wasm/issues>`__.
37+
38+
If the bug is a potential security vulnerability, please report using
39+
our `security
40+
policy <https://unit.nginx.org/troubleshooting/#getting-support>`__.
41+
42+
To report a non-security bug, open an
43+
`issue <https://github.com/nginx/unit-wasm/issues/new>`__ on GitHub with
44+
the label ``bug``. Be sure to include a title and clear description, as
45+
much relevant information as possible, and a code sample or an
46+
executable test case showing the expected behavior that doesn’t occur.
47+
48+
Suggest an Enhancement
49+
~~~~~~~~~~~~~~~~~~~~~~
50+
51+
To suggest an enhancement, open an
52+
`issue <https://github.com/nginx/unit-wasm/issues/new>`__ on GitHub with
53+
the label ``enhancement``. Please do this before implementing a new
54+
feature to discuss the feature first.
55+
56+
Open a Pull Request
57+
~~~~~~~~~~~~~~~~~~~
58+
59+
Clone the repo, create a branch, and submit a PR when your changes are
60+
tested and ready for review. Again, if you’d like to implement a new
61+
feature, please consider creating a feature request issue first to start
62+
a discussion about the feature.
63+
64+
Git Style Guide
65+
---------------
66+
67+
- Split your work into multiple commits is necessary. Each commit
68+
should make one logical change. I.e don’t mix code re-formatting with
69+
a fix in the same commit.
70+
71+
- Subject lines should be short (around 50 characters, not a hard rule)
72+
and concisely describe the change.
73+
74+
- The commit message body should be limited to 72 character lines.
75+
76+
- You can use subject line prefixes for commits that affect a specific
77+
portion of the code; examples include “libunit-wasm:” and
78+
“rust-bindings:”.
79+
80+
- Reference issues and PRs at the end of the commit messages, e.g if
81+
the commit remedies a GitHub issue add a tag like
82+
83+
Closes: https://github.com/nginx/unit-wasm/issues/NNN
84+
85+
If the commit fixes an issue introduced in a previous commit use the
86+
“Fixes” tag to reference it, e.g
87+
88+
Fixes: abbrev commit id (“Commit subject line”)

0 commit comments

Comments
 (0)