Skip to content

Commit

Permalink
update readme, contributing, wall
Browse files Browse the repository at this point in the history
  • Loading branch information
bonn0062 committed Feb 28, 2019
1 parent 444ab66 commit aaece26
Show file tree
Hide file tree
Showing 3 changed files with 110 additions and 17 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 making 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 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.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. 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
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Welcome to GitHub!!!

You've read the article, and now you must be here to contribute to your first open source project!
You've read the article, and now you're here to contribute to your first open source project!

It's time to leave a message for everyone who comes after you.

## Welcome to the official repository for the Towards Data Science Article,

[WTH am I doing here? The absolute beginner's guide to Git and GitHub: Getting started with Git and GitHub for the curious and completely confused (plus the easiest way to contribute to your first open source project ever!)](http://)
**This is the official repository for the Towards Data Science Article, [WTH am I doing here? The absolute beginner's guide to Git and GitHub: Getting started with Git and GitHub for the curious and completely confused (plus the easiest way to contribute to your first open source project ever!)](http://)**

![Photo by James Bold on Unsplash](unsplash_james_bold.jpeg)

Expand All @@ -22,12 +21,12 @@ Thinking way too hard about this? Feel free to copy and paste this message:

*Welcome to GitHub! You're amazing. Congratulations for making it this far!*

Now let's get started!
**Now let's get started!**


## Getting Started

It's all in the article! You're going to clone this repository, edit the *welcome_to_github.md* file to add a message of welcome to the next person or some other cool communication, and create your first pull request!
It's all in the article! You're going to clone this repository, edit the *welcome_wall.md* file to add an encouraging message (or some other cool communication) to the next person, and create your first pull request!

### Prerequisites

Expand All @@ -39,19 +38,37 @@ It's all in the article! You're going to clone this repository, edit the *welcom
* You might want to check out the article first
* You should have Git installed on your computer if you can
* You might want to know how to access your terminal so you can practice the whole thing
* It would be good to have a text editor so that you can grab the file and edit it on your computer
* It would be good to have a text editor so that you can grab the file and edit it on your computer just because learning is what this project is about.

*Here's the intro to the article if you landed here without it:*
## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the code of conduct, and the process for submitting pull requests to us.

## Authors

* **Anne Bonner**
* **Everyone of you who makes a successful pull request!**

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## You can find the full instructions in the article!

*Here's the intro if you landed here without it:*

Looking to get started with Git and GitHub? Do you need to collaborate with a team? Are you working on a project? Have you recently discovered that you pretty much need to be on GitHub if you want anyone to take you seriously in tech? 
…do you really just want to contribute to your first open source project?

This one's for you!

It's totally easy to get started with Git. If you're a fast reader (and you don't take a lot of time with sign up and installation), you can be up and running on GitHub about ten minutes from right now. 

If you go all the way through the article, you can practice cloning an existing repository, creating a branch, making changes, and then committing those changes. 

If you do all that, congratulations! You will have contributed to your first open source project!
This article will get you up and running with the basics. There's a lot of stuff to learn if you want to use Git and GitHub like a pro, of course. You can go way beyond this introductory information! We're going to leave the next-level stuff for another time, though.

Let's get started!

[Read the rest of the article here!](http://)
20 changes: 10 additions & 10 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Introduction


#Welcome!
# Welcome!

### First off, thank you for considering contributing to this GitHub welcome.
It's people like you that make this such a cool place to be!
### First off, thank you for considering contributing to this GitHub welcome wall.
It's people like you that make this such a fantastic place to be!

>Following these guidelines helps to communicate that you respect the time of the everyone learning, managing, and developing this open source project. In return, they should reciprocate that respect in addressing your questions, assessing changes, and helping you finalize your pull requests.
### All we're looking for from you is a warm and welcoming message to the people who come after you.
We're all here to learn, so let people know that they can do it!
We're all here to learn, so let people know that they can do it! Let people know that they are welcome to be here too.

> This is an open source project and I love to receive contributions from the community — you! There are many ways to contribute, so keep an open mind and think outside the box.
>
>I'm only looking for positive, warm, and welcoming messages. If you have something negative to communicate, please leave that pretty much anywhere else. Images, messages, and ideas that communicate negativity will not be approved.

Expand All @@ -26,7 +26,7 @@ Don't be a jerk! Be positive, be welcoming. Add your message here and then get o
> * Keep feature versions as small as possible, preferably one new feature per version.
> * Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the [Python Community Code of Conduct for a better description of what I mean](https://www.python.org/psf/codeofconduct/).
#Help!
# Help!
Not sure how you got here or how to get started? This is the repo for the article that will explain exactly that, [WTH am I doing here? The absolute beginner's guide to Git and GitHub](https://).

> Working on your first Pull Request? You can learn more from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
Expand All @@ -38,8 +38,8 @@ If a I ask you to "rebase" your PR, I'm saying that a lot of code has changed, a

# How to report a bug

> If you find a security vulnerability, do NOT open an issue. Notify me personally, please.
If you find a security vulnerability, do NOT open an issue. Notify me personally, please.
>
>It's unlikely you'll need to file an issue here. If you decide to file an issue, make sure to answer these five questions:
>
> 1. What version of your software are you using?
Expand All @@ -49,5 +49,5 @@ If a I ask you to "rebase" your PR, I'm saying that a lot of code has changed, a
> 5. What did you see instead?
# Just so you know
I look at Pull Requests on a regular basis.
> If feedback has been given, I expect responses within two weeks. After two weeks, I may close the pull request if it isn't showing any activity. Chances are, though, if you are submitting a simple note or image, your change will be merged without feedback. I'm just putting this here for the rare instance that I might need a little more information from you before adding your message to the repository.
I look at Pull Requests on a regular basis. I'm doing this on my own, so it might take a little time before I get to every pull request, but I promise I will!
> If feedback has been given, I expect responses within one month. After one month, I may close the pull request if it isn't showing any activity. Chances are, though, if you are submitting a simple note or image, your change will be merged without feedback. I'm just putting this here for the rare instance that I might need a little more information from you before adding your message to the repository.

0 comments on commit aaece26

Please sign in to comment.