✏️ Writing docs
This commit is contained in:
Liyas Thomas
@@ -34,12 +34,12 @@ Examples of unacceptable behavior by participants include:
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
behavior. Maintainers 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
|
||||
that are not aligned with our Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
|
||||
@@ -1,20 +1,20 @@
|
||||
# Contributing
|
||||
|
||||
When contributing to this repository, please first discuss the change you wish to make via issue,
|
||||
email, or any other method with the owners of this repository before making a change.
|
||||
email, or any other method with the owners of this repository before making a change.
|
||||
|
||||
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
||||
|
||||
## Pull Request Process
|
||||
|
||||
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
|
||||
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
|
||||
build.
|
||||
2. Update the README.md with details of changes to the interface, this includes new environment
|
||||
2. Update the README.md with details of changes to the interface, this includes new environment
|
||||
variables, exposed ports, useful file locations and container parameters.
|
||||
3. Increase the version numbers in any examples files and the README.md to the new version that this
|
||||
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
|
||||
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
|
||||
do not have permission to do that, you may request the second reviewer to merge it for you.
|
||||
4. You may merge the Pull Request once you have the sign-off of two other developers, or if you
|
||||
do not have permission to do that, you may request the second reviewer merge it for you.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
@@ -52,12 +52,12 @@ advances
|
||||
### Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
behavior. Maintainers 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
|
||||
that are not aligned with our Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
|
||||
76
README.md
76
README.md
@@ -336,13 +336,75 @@ This project is licensed under the [MIT License](https://opensource.org/licenses
|
||||
|
||||
## Badges
|
||||
|
||||
| Status | Preview | Markdown code (copy & paste into `readme.md`) |
|
||||
| ----------- | ----------- | ----------- |
|
||||
| **Default** | [](https://postwoman.io) | `[](https://postwoman.io)` |
|
||||
| **Success** | [](https://postwoman.io) | `[](https://postwoman.io)` |
|
||||
| **Critical** | [](https://postwoman.io) | `[](https://postwoman.io)` |
|
||||
| **Custom** | [](https://postwoman.io) | `[](https://postwoman.io)` |
|
||||
| Customize | [](https://postwoman.io) | `[](https://postwoman.io)` |
|
||||
<p>
|
||||
|
||||
[](https://postwoman.io)
|
||||
<details>
|
||||
<summary>Default</summary>
|
||||
<p>
|
||||
|
||||
```
|
||||
[](https://postwoman.io)
|
||||
```
|
||||
</p>
|
||||
</details>
|
||||
</p>
|
||||
<p>
|
||||
|
||||
---
|
||||
[](https://postwoman.io)
|
||||
<details>
|
||||
<summary>Success</summary>
|
||||
<p>
|
||||
|
||||
```
|
||||
[](https://postwoman.io)
|
||||
```
|
||||
</p>
|
||||
</details>
|
||||
</p>
|
||||
<p>
|
||||
|
||||
---
|
||||
[](https://postwoman.io)
|
||||
<details>
|
||||
<summary>Critical</summary>
|
||||
<p>
|
||||
|
||||
```
|
||||
[](https://postwoman.io)
|
||||
```
|
||||
</p>
|
||||
</details>
|
||||
</p>
|
||||
<p>
|
||||
|
||||
---
|
||||
[](https://postwoman.io)
|
||||
<details>
|
||||
<summary>Custom</summary>
|
||||
<p>
|
||||
|
||||
```
|
||||
[](https://postwoman.io)
|
||||
```
|
||||
</p>
|
||||
</details>
|
||||
</p>
|
||||
<p>
|
||||
|
||||
---
|
||||
[](https://postwoman.io)
|
||||
<details>
|
||||
<summary>Customize</summary>
|
||||
<p>
|
||||
|
||||
```
|
||||
[](https://postwoman.io)
|
||||
```
|
||||
</p>
|
||||
</details>
|
||||
</p>
|
||||
|
||||
<div align="center">
|
||||
<br>
|
||||
|
||||
Reference in New Issue
Block a user