Skip to content

Commit

Permalink
Adding docs folder
Browse files Browse the repository at this point in the history
Signed-off-by: Ivan Boothe <git@rootwork.org>
  • Loading branch information
rootwork committed Nov 9, 2021
1 parent bd68325 commit 8222a49
Show file tree
Hide file tree
Showing 7 changed files with 243 additions and 0 deletions.
80 changes: 80 additions & 0 deletions docs/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Premail Contributor Covenant Code of Conduct

<!-- This document gets mirrored to the Premail repo, so be sure all links are
absolute, not relative! -->

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make 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 within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project email 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 project maintainer using any of the
[contact options](https://github.com/premail/premail#support). 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>
63 changes: 63 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Contributing

Thank you for taking the time to contribute!

This component is open-source, and contributions are what make the open-source
community such an amazing place to learn, inspire, and create. Any contributions
you make will benefit everybody else and are **greatly appreciated**!

**Note:** We have a
[code of conduct](https://github.com/premail/mjml-bullet-list/blob/main/docs/CODE_OF_CONDUCT.md).
Please follow it in all your interactions with the project.

## Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe
you'd like a new feature? You can help us by
[submitting an issue on GitHub](https://github.com/premail/mjml-bullet-list/issues).
Before you create an issue, make sure to search the issue archive -- your issue
may have already been addressed!

Please try to create bug reports that are:

- _Reproducible._ Include steps to reproduce the problem.
- _Specific._ Include as much detail as possible: which version, what
environment, etc.
- _Unique._ Do not duplicate existing opened issues.
- _Scoped to a single bug._ One bug per report.

**Even better: Submit a pull request with a fix or new feature!**

## How to submit a Pull Request

1. Search our repository for open or closed
[Pull Requests](https://github.com/premail/mjml-bullet-list/pulls) that
relate to your submission. You don't want to duplicate effort.

2. [Fork the project on GitHub.](https://github.com/premail/mjml-bullet-list)

3. Create your feature branch:

```sh
git checkout -b feat/amazing_feature
```

4. Do your work.
**[Read the development process.](https://github.com/premail/mjml-bullet-list#fork-or-contribute-to-this-component)**

5. Commit your changes:

```sh
git commit -m 'feat: add amazing_feature'
```

6. Push to the branch:

```sh
git push origin feat/amazing_feature
```

7. [Open a Pull Request](https://github.com/premail/mjml-bullet-list/compare?expand=1)
and wait for feedback.

## 🎉 **Thank you for your contribution!**
24 changes: 24 additions & 0 deletions docs/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Security Policy

**This component is provided "as is" without any warranty. Use at your own
risk.**

## Reporting a Vulnerability

If there are any vulnerabilities in this component, don't hesitate to report
them to Premail.

1. Use any of the [contact options for Premail](https://github.com/premail).
2. Describe the vulnerability.

- If you have a fix, that is most welcome -- please attach or summarize it in
your message!

3. We will evaluate the vulnerability and, if necessary, release a fix or
mitigating steps to address it. We will contact you to let you know the
outcome, and will credit you in the report.

- Please **do not disclose the vulnerability publicly** until a fix is released!

4. Once we have either a) published a fix, or b) declined to address the
vulnerability for whatever reason, you are free to publicly disclose it.
Binary file added docs/images/icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/images/icon.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions docs/images/logo.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8222a49

Please sign in to comment.