Skip to content

Commit

Permalink
Merge pull request #3 from glasnt/topic/coc
Browse files Browse the repository at this point in the history 
Template Contributing namespace - pybee.org/contributing
  • Loading branch information
@freakboy3742
freakboy3742 committed Dec 5, 2015
2 parents aa0c571 + 5273503 commit d251fb2
Show file tree
Hide file tree
Showing 8 changed files with 420 additions and 141 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Contributing

PyBee <3's Contributions!

Please be aware, PyBee operates under a Code of Conduct.

See [CONTRIBUTING to PyBee](pybee.org/contributing)

304 changes: 304 additions & 0 deletions contributing/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,304 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>BeeWare - The IDEs of Python</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="">

<!-- Le styles -->
<link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Cutive">

<link href="../static/bootstrap/css/bootstrap.css" rel="stylesheet">
<link href="../static/css/styles.css" rel="stylesheet">
<link href="../static/bootstrap/css/bootstrap-responsive.css" rel="stylesheet">

<link href="http://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.css" rel="stylesheet">

<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="../static/bootstrap/js/html5shiv.js"></script>
<![endif]-->

<!-- Fav and touch icons -->
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="../static/images/brutus-144.png">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="../static/images/brutus-114.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="../static/images/brutus-72.png">
<link rel="apple-touch-icon-precomposed" href="../static/images/brutus-57.png">
<link rel="shortcut icon" href="../static/images/brutus-32.png">


<style> h2, h3 { padding-top: 1em } </style>
<!-- Google tracking -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-2943925-4', 'pybee.org');
ga('send', 'pageview');

</script>
</head>

<body>

<div class="navbar navbar-inverse navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="brand" href="../index.html">BeeWare</a>
<div class="nav-collapse collapse">
<ul class="nav">
<li><a href="../index.html#tools">Tools</a></li>
<li><a href="../index.html#libraries">Libraries</a></li>
<li><a href="#">Contributing</a></li>
<li><a href="#contact">Contact</a></li>
</ul>
</div><!--/.nav-collapse -->
</div>
</div>
</div>

<div class="container">
<div class="hero-unit">
<div class="row-fluid">
<div class="span3">
<img src="../static/images/brutus-270.png">
</div>
<div class="span9">
<h1 style="white-space: nowrap">Contributing to BeeWare</h1>
<h1 style="font-size: 45px"> -- in a nutshell</h1>
The BeeWare community adheres to the
<a href="http://www.python.org/psf/codeofconduct/">Python community code of conduct</a>.
If you have any concerns about this code of conduct, or you wish to report a violation
of this code, please <a href="mailto:russell@keith-magee.com">get in touch</a>.
<p></p>
<p>If you experience problems with any of the PyBee products, log them in GitHub. If you want to contribute, fork the code and submit a pull request.
</div>
</div>
</div>

<h1>BeeWare Community Code of Conduct</h1>
<p>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.</p>

<p>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.</p>

<p>Examples of unacceptable behavior by participants include:</p>

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

<p>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.</p>

<p>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.</p>

<p>This code of conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.</p>

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

<p><i>This Code of Conduct is adapted from the Contributor Covenant, version 1.3.0, available from
<a href="http://contributor-covenant.org/version/1/3/0/">http://contributor-covenant.org/version/1/3/0/</a></i></p>

<hr>


<h1 id='libraries'>Contributing to BeeWare</h1>
<p><i>This GitHub tutorial is lovingly based on the <a href="https://github.com/DjangoGirls/tutorial/">DjangoGirls How To Contribute Tutorial</a>, which is available under a Creative Commons Attribution-ShareAlike 4.0 license.</i>


<p>For this tutorial, we will be using the <a href="https://github.com/pybee/voc">VOC</a> repository as a bases for the links and references</p>
<h2>Getting started and prerequisites</h2>

<p>For contributing to BeeWare, the following is needed to get started:</p>

<ul>
<li>a <a href="https://github.com">Github account</a></li>
<li>in the case of complex edits familiarity with <a href="https://help.github.com/articles/set-up-git">Git command line basics</a> or familiarity with an app (<a href="https://windows.github.com/">Windows</a>, <a href="https://mac.github.com/">Mac</a>) to push your edits made on your computer to Github.</li>
</ul>

<h3>Fork the repository</h3>

<p>First fork the <a href="https://github.com/pybee/voc">VOC</a> repository to your personal Github account:</p>

<p><img src="../static/images/fork.png" alt="Fork button"></p>

<h2>Editing Documentation</h2>

<h3>Simple changes</h3>

<p>For simple changes like typo corrections you can use the Github online editor:</p>

<ul>
<li>Open your local fork page on Github,</li>
<li>go to <em>README.md</em> file in any chapter,</li>
<li>press the <em>Edit</em> icon (pen)</li>
</ul>

<p>and you can edit the chapter directly on github.com.</p>

<p><img src="../static/images/edit.png" alt="Edit button"></p>

<p>Markdown syntax is used to edit the individual pages of the documentation.</p>

<p><img src="../static/images/github_editor.png" alt="Github editor"></p>

<p>Save your changes and create a pull request as explained below.</p>

<h3>New code and complex changes</h3>

<p>For adding new code, extending classes, or complex changes, you need to get a copy of the code to your local computer.</p>

<p>Either use the Github app for your operating system (mentioned above) or <code>git</code> command line to get the repository locally. You get the repository address from the front page of your own Github repository fork:</p>

<pre><code>git clone git@github.com:yourusername/voc.git
</code></pre>

<p>Then, create a branch for your new changes to sit in. It helps to call the branch something related to the changes you are going to make.</p>

<pre><code>git checkout -b update_documentation
</code></pre>

<p>Make any changes in the code, and ensure they are tested, and saved locally.</p>

<p>Then commit the changes using <code>git</code> and push the changes to your remote Github repository.</p>

<p>Example:</p>

<pre><code>$ git status
On branch update_documentation
Untracked files:
(use "git add &lt;file&gt;..." to include in what will be committed)

README.md

$ git add README.md

$ git commit -m "Update README.md documentation for VOC"
[update_documentation fe36152] Added gitbook screenshot
1 file changed, 0 insertions(+), 0 deletions(-)
create mode 100644 README.md

$ git push
Counting objects: 11, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (5/5), done.
Writing objects: 100% (5/5), 266.37 KiB | 0 bytes/s, done.
Total 5 (delta 1), reused 0 (delta 0)
To git@github.com:yourusername/voc.git
b37ca59..fe36152 update_documentation -&gt; update_documentation
</code></pre>

<h2>Making a pull request</h2>

<p>After you have finished your changes you need to create <a href="https://help.github.com/articles/using-pull-requests">a pull request</a> on Github. PyBee will get notified about the pull request, review your changes, suggest any corrections if needed and then <em>pull</em> your changes to the master version.</p>

<p>In your own repository on Github press do <em>Compare &amp; pull request</em></p>

<p><img src="../static/images/pull_request.png"></p>

<p>Fill in the information <em>why</em> this change is being made. The reviewer can see the details of the actual change, so you don't need repeat the content of the change.</p>

<p>Then press <em>Create pull request</em>.</p>

<p>Github emails will notify you for the follow up process.</p>

<hr>
<h3>Learn more about the git process</h3>
<p>There are many useful resources to help you learn how to log issues and raise Pull Requests in GitHub</p>
<p><ul>
<li> <a href="https://guides.github.com/activities/contributing-to-open-source/#contributing">Contributing to Open Source</a> from GitHub.com
<li> <a href="https://help.github.com/articles/fork-a-repo/">How to Fork a Repo</a> from GitHub.com
</p>
<hr>

<div class="contacts row-fluid">
<div class="span6">
<h2 id='community'>Community</h2>
<div class="clearfix">
<a class="icon pull-left" href="https://groups.google.com/forum/#!forum/beeware-users">
<i class="icon-inbox"></i>
</a>
<div>
<h3>Users mailing list</h3>
Got any questions about how to use a tool in the BeeWare suite? Join the <a href="https://groups.google.com/forum/#!forum/beeware-users">BeeWare Users Mailing list</a> and ask.
</div>
</div>

<div class="clearfix">
<a class="icon pull-left" href="https://groups.google.com/forum/#!forum/beeware-developers">
<i class="icon-inbox"></i>
</a>
<div>
<h3>Developers mailing list</h3>
Got some ideas for how we can improve a tool in BeeWare suite? Or have an idea for a completely new tool? Join the <a href="https://groups.google.com/forum/#!forum/beeware-developers">BeeWare Developers Mailing list</a> and let us know your ideas.
</div>
</div>


</div>
<div class="span6">
<h2 id='contact'>Contact</h2>

<div class="clearfix">
<a class="icon pull-left" href="https://groups.google.com/forum/#!forum/beeware-announcements">
<i class="icon-inbox"></i>
</a>
<div>
<h3>Announcements</h3>
Just want to keep in the loop when the BeeWare project has something to announce? Join the <a href="https://groups.google.com/forum/#!forum/beeware-announcements">BeeWare Announcements Mailing list</a>.
</div>
</div>

<div class="clearfix">
<a class="icon pull-left" href="https://twitter.com/pybeeware">
<i class="icon-twitter-sign"></i>
</a>
<div>
<h3>Twitter</h3>
Keep in touch by following <a href="https://twitter.com/pybeeware"><strong>@pybeeware</strong> on Twitter</a>.
</div>
</div>

<div class="clearfix">
<a class="icon pull-left" href="mailto:russell@keith-magee.com">
<i class="icon-dollar"></i>
</a>
<div>
<h3>Funding</h3>
Interested in providing other financial assistance to the BeeWare project? <a href="mailto:russell@keith-magee.com">Please get in touch</a>.
</div>
</div>

</div>
</div>
<hr>
<footer>
<p>&copy; Russell Keith-Magee 2013</p>
</footer>

</div> <!-- /container -->
</body>
</html>
Loading

0 comments on commit d251fb2

Please sign in to comment.