Skip to content

Latest commit

 

History

History
74 lines (41 loc) · 3.9 KB

CONTRIBUTING.md

File metadata and controls

74 lines (41 loc) · 3.9 KB
Raw

Contributing to ACMEd

Testing and bug report

The first way to help is to actually use the software and report any bug you encounter. Do not hesitate to test the limits.

Improving the language

Since the author is not a native English speaker, some of the texts used in this project should be fixed. This is especially true on the man pages as well as the wiki.

Package it for your favorite system

A great way to contribute to the project is to package it. You can check the packages status on Repology.

Work on dependencies

rust-openssl

See issue #36.

botan and botan-sys

Although Botan isn't a dependency, it is considered for the replacement of OpenSSL as the default cryptographic API (although OpenSSL will be kept as an alternative). But before this can be done, the Botan crate need to support a few features:

  • Implement Clone for botan::Privkey.
  • Access to a certificate's expiration time (via botan_sys::botan_x509_cert_get_time_expires).
  • Access to a certificate's subject's alt names.
  • Self-signed certificate generation (via botan_sys::botan_x509_cert_gen_selfsigned).
  • CSR (requires to add bindings to create_cert_req) with DER export.

If you know C/C++ and are highly motivated:

  1. Implement Botan's FFI for TLS.
  2. Implement TLS bindings in the botan-sys crate.
  3. Implement a TLS abstraction in the botan crate.

attohttpc

Add an optional Botan support as the cryptographic library.

Find or create a good template engine

As reported in issue #8, there is currently no perfect template engine. A good way to help improve ACMEd would be to find or create one that supports all the listed requirements.

Improving the code

As a one-man project, it has several goals already set but not explicitly written in an issue or any other follow-up file. It will not be the case before version 1.0 is released since everything may change at any moment. Therefore, it is recommended to request change instead of implementing them, this way we can discuss how things should be made.

If you really want to submit a pull request, please :

  • document your changes in the man pages and the CHANGELOG.md file
  • write as much tests as you can
  • run cargo test and be sure every test pass
  • format your code using rustfmt
  • be sure not to have any warning when compiling
  • run clippy and fix any issue
  • refrain from including a new dependency (crates having ring in their dependency tree are a no-go, see #2)
  • beware of potential repercussions on the default hooks: those should remain usable

Not following the rules above will delay the merge since they will have to be fixed first.

Author vs. contributor

Some people have troubles seeing the difference between an author and a contributor. Here is how it is seen withing this project.

A contributor is a person who helps the project in various ways whenever she or he wants. As such, a contributor does not have any obligation other than being respectful and open-minded. People who wrote code that have been accepted are automatically listed in the contributors page. The creation of a file with the names of people contributing outside of the code base will be studied upon request from such people.

An author is a person who has some responsibilities on the project. Authors are expected to contribute on a regular basis, decide architectural choices, enforce copyright issues and so on. One does not grant himself the author status, it is given by the others authors after having discussed the request.