Skip to content

Convert docs to reStructuredText #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,174 changes: 0 additions & 1,174 deletions API-C.md

This file was deleted.

1,274 changes: 1,274 additions & 0 deletions API-C.rst

Large diffs are not rendered by default.

1,138 changes: 0 additions & 1,138 deletions API-Rust.md

This file was deleted.

1,238 changes: 1,238 additions & 0 deletions API-Rust.rst

Large diffs are not rendered by default.

74 changes: 0 additions & 74 deletions CODE_OF_CONDUCT.md

This file was deleted.

88 changes: 88 additions & 0 deletions CODE_OF_CONDUCT.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
Contributor Covenant Code of Conduct
====================================

Our Pledge
----------

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, sex
characteristics, gender identity and expression, level of experience,
education, socio-economic status, nationality, personal appearance,
race, religion, or sexual identity and orientation.

Our Standards
-------------

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual
attention or advances
- Trolling, insulting/derogatory comments, and personal or political
attacks
- Public or private harassment
- Publishing others’ private information, such as a physical or
electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

Our Responsibilities
--------------------

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.

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.

Scope
-----

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.

Enforcement
-----------

Instances of abusive, harassing, or otherwise unacceptable behavior may
be reported by contacting the moderation team at
nginx-oss-community@f5.com. All complaints will be reviewed and
investigated and will result in a response that is deemed necessary and
appropriate to the circumstances. The project team is obligated to
maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted
separately.

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 project’s leadership.

Attribution
-----------

This Code of Conduct is adapted from the `Contributor
Covenant <https://www.contributor-covenant.org>`__, version 1.4,
available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
83 changes: 0 additions & 83 deletions CONTRIBUTING.md

This file was deleted.

88 changes: 88 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
Contributing Guidelines
=======================

The following is a set of guidelines for contributing to unit-wasm. We
do appreciate that you are considering contributing!

Table Of Contents
-----------------

- `Getting Started <#getting-started>`__
- `Ask a Question <#ask-a-question>`__
- `Contributing <#contributing>`__
- `Git Style Guide <#git-style-guide>`__

Getting Started
---------------

Check out the `README <README.md>`__.

Ask a Question
--------------

Please open an `issue <https://github.com/nginx/unit-wasm/issues/new>`__
on GitHub with the label ``question``. You can also ask a question on
`Slack <https://nginxcommunity.slack.com>`__ or the NGINX Unit mailing
list, unit@nginx.org (subscribe
`here <https://mailman.nginx.org/mailman3/lists/unit.nginx.org/>`__).

Contributing
------------

Report a Bug
~~~~~~~~~~~~

Ensure the bug was not already reported by searching on GitHub under
`Issues <https://github.com/nginx/unit-wasm/issues>`__.

If the bug is a potential security vulnerability, please report using
our `security
policy <https://unit.nginx.org/troubleshooting/#getting-support>`__.

To report a non-security bug, open an
`issue <https://github.com/nginx/unit-wasm/issues/new>`__ on GitHub with
the label ``bug``. Be sure to include a title and clear description, as
much relevant information as possible, and a code sample or an
executable test case showing the expected behavior that doesn’t occur.

Suggest an Enhancement
~~~~~~~~~~~~~~~~~~~~~~

To suggest an enhancement, open an
`issue <https://github.com/nginx/unit-wasm/issues/new>`__ on GitHub with
the label ``enhancement``. Please do this before implementing a new
feature to discuss the feature first.

Open a Pull Request
~~~~~~~~~~~~~~~~~~~

Clone the repo, create a branch, and submit a PR when your changes are
tested and ready for review. Again, if you’d like to implement a new
feature, please consider creating a feature request issue first to start
a discussion about the feature.

Git Style Guide
---------------

- Split your work into multiple commits is necessary. Each commit
should make one logical change. I.e don’t mix code re-formatting with
a fix in the same commit.

- Subject lines should be short (around 50 characters, not a hard rule)
and concisely describe the change.

- The commit message body should be limited to 72 character lines.

- You can use subject line prefixes for commits that affect a specific
portion of the code; examples include “libunit-wasm:” and
“rust-bindings:”.

- Reference issues and PRs at the end of the commit messages, e.g if
the commit remedies a GitHub issue add a tag like

Closes: https://github.com/nginx/unit-wasm/issues/NNN

If the commit fixes an issue introduced in a previous commit use the
“Fixes” tag to reference it, e.g

Fixes: abbrev commit id (“Commit subject line”)
Loading