Skip to content

Commit

Permalink
merge README
Browse files Browse the repository at this point in the history
  • Loading branch information
gutschilla committed Jun 19, 2019
2 parents 81e4191 + 5fd111e commit f6f0aad
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing

Everyone is invited to contribute to this project.

**A BIG THANK YOU** to all of those who already made this project more helpful for everyone.

# Scope

This project is only about generating PDFs from HTML. That HTML can come from either
a string (the HTML itself) or a URL (the body of a GET request to that URL).
Other sources can be SVG (both Chrome and wkhtmltopdf support this), JPEG or
anything else that a Webkit-based Browser would display and print to a PDF.

Anything else like preprocessing the input (HTML templating) or postprocessing the PDF
(moving it somewhere, glueing it together with other PDFs) apart from encryption
(currently done via PDFTK) is not in scope of this project.

See https://github.com/gutschilla/elixir-pdf-server for an example of how to include
more functionality by just _importing_ this project.

# Maintainer's duties

1. I will try hard to review every PR or issue in a timely manner (within a few
business days, unless I am on vacations). I am a father, husband and do have a
day job so please do not expect ultra-immediate responses.
2. I will give usable feedback for why I won't accept a PR

# A kind request to contributors

- for any contribution, describe your intentions first
- if possible, provide tests and documentation with your PR
- if possible, come up with a PR in the first place
- comply with https://github.com/christopheradams/elixir_style_guide (I am not dogmatic about this one)
- be kind and helpful to everyone as I am trying hard to be as well

# On bug reports

- Until now, I didn't feel anyone was unkind or offensive
- nor was anybody looking for me to fix his/her code

While this stays that way, I feel there's no need to enforce good manners :-)
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,3 +264,9 @@ like `--foo=bar` to be split up as `["--foo", "bar"]`. This behaviour seemingly
went away with OTP 22 in May 2019 and Elixir 1.8.2. So if you run into issues,
try upgrading to the latest Erlang/OTP and Elixir first, and do not hesitate
file a report.

# Contributing

Contributions (Issues, PRs…) are more than welcome. Please ave a quick read at
the [Contribution tips](./CONTRIBUTING.md), though. It's basically about scope
and kindness.

0 comments on commit f6f0aad

Please sign in to comment.