Skip to content

Latest commit

 

History

History
16 lines (11 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

16 lines (11 loc) · 1.28 KB

Welcome to the go-objectid contributing guide

First, welcome to the go-objectid repository. This repository offers a package allowing true, unbounded ASN.1 OBJECT IDENTIFIER support in Golang with many convenient features and encoding/decoding support. The goal of this package is to offer a means of avoiding the shortcomings of the "encoding/asn1" package in terms of OID support.

Contributor guide

A few things should be reviewed before submitting a contribution to this repository:

  1. Read our Code of Conduct to keep our community approachable and respectable.
  2. Review the main GoDoc page, which provides the entire suite of useful documentation rendered in Go's typically slick manner 😎.
  3. Review the Collaborating with pull requests document, unless you're already familiar with its concepts ...
  4. Keep cyclomatic factors <= 9
  5. Keep test coverage at 100%
  6. All exported constructs -- methods, functions, types, global vars -- must be commented in proper English grammar.

So long as these rules are honored, contributions are welcome.