Skip to content

Commit

Permalink
Update project documentation
Browse files Browse the repository at this point in the history
Add code of conduct. Improve contribution guide.
  • Loading branch information
mp911de committed Feb 19, 2020
1 parent c8ce24c commit 265f9ec
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 6 deletions.
44 changes: 44 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, and in the interest of fostering an open
and welcoming community, we pledge to respect all people who contribute through reporting
issues, posting feature requests, updating documentation, submitting pull requests or
patches, and other activities.

We are committed to making participation in this project a harassment-free experience for
everyone, regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance, body size, race, ethnicity, age,
religion, or nationality.

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery
* Personal attacks
* Trolling or insulting/derogatory comments
* Public or private harassment
* Publishing other's private information, such as physical or electronic addresses,
without explicit permission
* Other unethical or unprofessional conduct

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.

By adopting this Code of Conduct, project maintainers commit themselves to fairly and
consistently applying these principles to every aspect of managing this project. Project
maintainers who do not follow or enforce the Code of Conduct may be permanently removed
from the project team.

This Code of Conduct applies both within project spaces and in public spaces when an
individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
contacting a project maintainer 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. Maintainers are obligated to maintain confidentiality
with regard to the reporter of an incident.

This Code of Conduct is adapted from the
[Contributor Covenant](https://contributor-covenant.org), version 1.3.0, available at
[contributor-covenant.org/version/1/3/0/](https://contributor-covenant.org/version/1/3/0/).
37 changes: 31 additions & 6 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
# Contributing to Lettuce

Lettuce is released under the Apache 2.0 license. If you would like to contribute something, or simply want to hack on the code this document should help you get started.

## Code of Conduct

This project adheres to the Contributor Covenant [code of
conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

## Using GitHub Issues

We use GitHub issues to track bugs and enhancements. If you have a general usage question please ask on [Stack Overflow](https://stackoverflow.com).
The Lettuce team and the broader community monitor the [`lettuce`](https://stackoverflow.com/tags/lettuce) tag.

If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible.
Ideally, that would include a small sample project that reproduces the problem.

## Quickstart

For the impatient, if you want to submit a quick pull request:
For the impatient, if you want to submit a quick pull request:

* Don't create a pull request upfront. Create a feature request ticket first so we can discuss your idea.
* Don't create a pull request upfront. Create a feature request ticket first, so we can discuss your idea.
* Upon agreeing the feature is a good fit for Lettuce, please:
* Make sure there is a ticket in GitHub issues.
* Make sure you use the code formatters provided here and have them applied to your changes. Don’t submit any formatting related changes.
Expand Down Expand Up @@ -36,7 +51,7 @@ If you want to request a feature, please ensure to specify the following:

## Questions

If you have a question, then check one of the following places first. Typically, forums, chats, and mailing lists are the best place to ask your question as you can expect to get an answer faster there:
If you have a question, then check one of the following places first as GitHub issues are for bugs and feature requests. Typically, forums, chats, and mailing lists are the best place to ask your question as you can expect to get an answer faster there:

**Checkout the docs**

Expand All @@ -50,8 +65,18 @@ If you have a question, then check one of the following places first. Typically,
* Stack Overflow (Questions): [Questions about Lettuce](https://stackoverflow.com/questions/tagged/lettuce)
* Gitter (General discussion): [![Join the chat at https://gitter.im/lettuce-io/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lettuce-io/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## License
### Building from Source

Lettuce source can be built from the command line using Maven on JDK 1.8 or above.

The project can be built from the root directory using the standard Maven command:

```bash
$ mvn clean test
```

By contributing your code, you agree to license your contribution under the terms of [Apache License 2.0] (https://www.apache.org/licenses/LICENSE-2.0).
You can run a full build including integration tests using the `make` command:

All files are released with the Apache 2.0 license.
```bash
$ make test
```

0 comments on commit 265f9ec

Please sign in to comment.