Skip to content

Commit

Permalink
docs: add CODE_OF_CONDUCT and CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
jimlambrt committed Jan 26, 2022
1 parent ad93cf2 commit af454f9
Show file tree
Hide file tree
Showing 2 changed files with 141 additions and 0 deletions.
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## 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 e-mail 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 team at [email protected]. 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][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
65 changes: 65 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Contributing to gldap

Thank you for contributing to gldap! Here you can find common questions around reporting issues and opening
pull requests to our project.

When contributing in any way to the gldp project (new issue, PR, etc), please be
aware that our community identifies with many gender pronouns. Please remember
to use nonbinary pronouns (they/them) and gender neutral language ("Hello
folks") when addressing our community. For more reading on our code of conduct,
please see the [Code of Conduct](CODE_OF_CONDUCT.md).

## Issue Reporting
### Reporting Security Related Vulnerabilities

We take gldap's security and our users' trust very seriously. If you believe you have found a security issue
in gldap, please responsibly disclose by contacting us at [email protected]. Do not open an issue on
our GitHub issue tracker if you believe you've found a security related issue, thank you!

### Bug Fixes

If you believe you found a bug with gldap, please:

1. Build from the latest `main` HEAD commit to attempt to reproduce the issue. It's possible we've already fixed
the bug, and this is a first good step to ensuring that's not the case.
1. Ensure a similar ticket is not already opened by searching our opened issues on GitHub.


Once you've verified the above, feel free to open a bug fix issue template type from our [issue selector](https://github.com/hashicorp/jimlambrt/gldap/issues/new/choose)
and we'll do our best to triage it as quickly as possible.

## Pull Requests

### New Features & Improvements

Before writing a line of code, please ask us about a potential improvement or feature that you want to write into gldap. We may already be working on it; even if we aren't, we need to ensure that both the feature and its proposed implementation is aligned with our road map, vision, and standards for the project. We're happy to help walk through that via a [feature request issue](https://github.com/hashicorp/jimlambrt/gldap/issues/new/choose).

You can see a public [road map for gldap](README.md) in the README and we encourage
everyone to look this over to understand at a high level what we're working on with gldap.

### Submitting a New Pull Request

When submitting a pull request, please ensure:

1. You've followed the above guidelines for contributing to gldap.

Please allow us a couple of days to comment, request changes, or approve your PR. Thank you for your contribution!

## Testing

To run the entire test suite run this command in the root of the project:

```
$ make test
```

### Running individual tests

If you don't want to run the entire test suite, you can just run a singe test
with go. For example, if you wanted to run the tests
TestDirectory_SimpleBindResponse, you would run:

```
$ go test -run TestDirectory_SimpleBindResponse
```

0 comments on commit af454f9

Please sign in to comment.