Skip to content

Commit

Permalink
Merge pull request #20 from betatim/contrib
Browse files Browse the repository at this point in the history
Contributor guide and claiming credit
  • Loading branch information
betatim committed Sep 24, 2015
2 parents 12796db + 8227be8 commit 42845c5
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 1 deletion.
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing

`everware` is an open source project, and we welcome contributions of all kinds

To report a bug, open an issue on our [issue tracker][issues].

By contributing, you are agreeing that we may redistribute your work under
[these licenses][license].

We use the [fork and pull][gh-fork-pull] model to manage changes. More information
about [forking a repository][gh-fork] and [making a Pull Request][gh-pull].

To contribute to this repository:

1. fork [the project repository](https://github.com/everware/everware/).
Click on the 'Fork' button near the top of the page. This creates a copy of
the code under your account on the GitHub server.
2. clone this copy of the repository to your local disk:

$ git clone git@github.com:YourLogin/everware.git
$ cd everware

2. create a new branch in your clone `git checkout -b my-new-branch`. Never
work in the ``master`` branch!
4. Work on this copy on your computer using Git to do the version
control. When you're done editing, do:

$ git add modified_files
$ git commit

to record your changes in Git, then push them to GitHub with:

$ git push -u origin my-new-branch

Finally, go to the web page of your fork of the `everware` repo,
and click 'Pull request' to send your changes to the maintainers for
review. This will send an email to the committers.

There is one additional rule: no one can merge their own pull requests, someone
else has to press the button.

[issues]: https://github.com/everware/everware/issues
[license]: LICENSE
[gh-fork]: https://help.github.com/articles/fork-a-repo/
[gh-pull]: https://help.github.com/articles/using-pull-requests/
[gh-fork-pull]: https://help.github.com/articles/using-pull-requests/#fork--pull
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2015, Jupyter Development Team, Igor Babuschkin
Copyright (c) 2015, Jupyter Development Team, Igor Babuschkin, Tim Head
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down

0 comments on commit 42845c5

Please sign in to comment.