Skip to content

Commit

Permalink
Autofix: Add community files
Browse files Browse the repository at this point in the history 
[atomist:generated] [atomist:autofix=add_community_files]
  • Loading branch information
@atomist-bot
atomist-bot committed Apr 5, 2019
1 parent dd11db3 commit 4dbb380
Show file tree
Hide file tree
Showing 2 changed files with 134 additions and 90 deletions.
114 changes: 57 additions & 57 deletions CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
@@ -1,68 +1,68 @@
# Contributor Covenant Code of Conduct


In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

contributors and maintainers pledge to making participation in our
project and our community a harassment-free experience for everyone,
regardless of age, body size, disability, ethnicity, gender identity
and expression, level of experience, nationality, personal appearance,
race, religion, or sexual identity and orientation.

Examples of behavior that contributes to creating a positive environment
include:
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
* 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


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.


This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. 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.


Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [[email protected]][email]. 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.


This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]
* 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

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.

This Code of Conduct applies both within project spaces and in public
spaces when an individual is representing the project or its
community. 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.

Instances of abusive, harassing, or otherwise unacceptable behavior
may be reported by contacting the project team
at [[email protected]][email]. 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.

This Code of Conduct is adapted from
the [Contributor Covenant][homepage], version 1.4, available
at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
Expand Down
110 changes: 77 additions & 33 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,53 +1,93 @@
# Contributing to Atomist Open Source Projects
# Contributing to Atomist open source projects

Have something you would like to contribute to this project? Awesome, and thanks for taking time to contribute! Here's what you need to know.
Have something you would like to contribute to this project? Awesome,
and thanks for taking time to contribute! Here's what you need to
know.

## Contributing code

Is there an improvement to existing functionality or an entirely new feature you would like to see? Before creating enhancement suggestions, please check the issue list as you might find out that you don't need to create one.
Is there an improvement to existing functionality or an entirely new
feature you would like to see? Before creating enhancement
suggestions, please check the issue list as you might find out that
you don't need to create one.

Did you know we have a [Slack community][slack]? This might be a great place to talk through your idea before starting. It allows you to see if anyone else is already working on something similar, having the same issue or to get feedback on your enhancement idea. Discussing things with the community first is likely to make the contribution process a better experience for yourself and those that are maintaining the projects.
Did you know we have a [Slack community][slack]? This might be a
great place to talk through your idea before starting. It allows you
to see if anyone else is already working on something similar, having
the same issue or to get feedback on your enhancement idea.
Discussing things with the community first is likely to make the
contribution process a better experience for yourself and those that
are maintaining the projects.

[slack]: https://join.atomist.com/

If you do not find an open issue related to your contribution and discussions in the Slack community are positive, the next thing to do is to create an issue in the appropriate GitHub repository.


* Before we can accept any code changes into the Atomist codebase, we need to get some of the legal stuff covered. This is pretty standard for open-source projects. We are using [cla-assisant.io](https://cla-assistant.io/) to track our CLA signatures. Please ensure you sign our [Contributor License Agreement (CLA)](https://cla-assistant.io/atomist/rug).
If you do not find an open issue related to your contribution and
discussions in the Slack community are positive, the next thing to do
is to create an issue in the appropriate GitHub repository.

* Before we can accept any code changes into the Atomist codebase,
we need to get some of the legal stuff covered. This is pretty
standard for open-source projects. We are using
[cla-assisant.io][cla-assistant] to track our Contributor License
Agreement (CLA) signatures. If you have not signed a CLA for the
repository to which you are contributing, you will be prompted to
when you create a pull request (PR).
* Be sure there is an open issue related to the contribution.
* Code contributions should follow our [coding conventions](http://docs.atomist.com/reference-docs/rug-conventions/).
* Commit messages should follow the [standard format](http://chris.beams.io/posts/git-commit/) and should include a [reference](https://github.com/blog/957-introducing-issue-mentions) to the open issue they are addressing.
* All code contributions should be submitted via a [pull request (PR) from a forked GitHub repository](https://guides.github.com/activities/contributing-to-open-source/).
* Code contributions should successfully build and pass tests.
* Commit messages should follow the [standard format][commit] and
should include a [reference][ref] to the open issue they are
addressing.
* All code contributions should be submitted via
a [pull request (PR) from a forked GitHub repository][pr].
* Your PR will be reviewed by an Atomist developer.



Please go through the checklist below before submitting. There's a chance it may have already been reported, or resolved.

* Check if you can reproduce the problem in the latest version of the project.
* Search the [atomist-community](https://join.atomist.com) Slack community for common questions and problems.
* Understand which repo the bug should be reported in.
* Scan the list of issues to see if the problem has previously been reported. If so, you may add a comment to the existing issue rather than creating a new one.


You went through the list above and it is still something you would like to report? Then, please provide us with as much of the context, by explaininig the problem and including any additional details that would help maintainers reproduce the problem. The more details you provide in the bug report, the better.

Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide as much information as possible. Feel free to use the [bug report template](#bug-report-template) below if you like.
[cla-assistant]: https://cla-assistant.io/
[commit]: http://chris.beams.io/posts/git-commit/
[ref]: https://github.com/blog/957-introducing-issue-mentions
[pr]: https://guides.github.com/activities/contributing-to-open-source/

## Reporting problems

Please go through the checklist below before reporting a
problem. There's a chance it may have already been reported, or
resolved.

* Check if you can reproduce the problem in the latest version of
the project.
* Search the [atomist-community Slack][slack] community for common
questions and problems.
* Understand which repo the bug should be reported in.
* Scan the list of issues to see if the problem has previously been
reported. If so, you may add a comment to the existing issue
rather than creating a new one.

You went through the list above and it is still something you would
like to report? Then, please provide us with as much of the context,
by explaininig the problem and including any additional details that
would help maintainers reproduce the problem. The more details you
provide in the bug report, the better.

Bugs are tracked as GitHub issues. After you've determined which
repository your bug is related to, create an issue on that repository
and provide as much information as possible. Feel free to use
the bug report template below if you like.

At a minimum include the following:

* Where did you find the bug? For example, did you encounter the bug using a button, the bot, or the CLI?
* What version are you using?
* What command were you using when it happened? (including params where applicable)

* Where did you find the bug? For example, did you encounter the bug
in chat, the CLI, somewhere else?
* What version are you using?
* What command were you using when it happened? (including
parameters where applicable)

```
[Description of the problem]
**How to Reproduce:**
1. [First Step]
2. [Second Step]
3. [n Step]
1. [First Step]
2. [Second Step]
3. [n Step]
**Expected behavior:**
Expand All @@ -63,8 +103,12 @@ At a minimum include the following:
**Project version:** [Enter project version]
**Atomist CLI version:** [Enter CLI version]
```

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

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].
[conduct]: CODE_OF_CONDUCT.md
[email]: mailto:[email protected]

0 comments on commit 4dbb380

Please sign in to comment.