Skip to content

Latest commit

 

History

History
129 lines (84 loc) · 4.54 KB

CONTRIBUTING.md

File metadata and controls

129 lines (84 loc) · 4.54 KB
Raw

Welcome to the contributing guide for circuits!

Team members

Learn & listen

Adding new features

Got a great new feature you'd like to add? Great! First let's discuss it either on the #circuits IRC Channel or create a new Discussion Issue.

Once we're all on the same page and we've nutted down the design and requirements together let's get you hacking and take ownership of the new feature!

$ git clone [email protected]:myuser/circuits.git
  • Create a new feature branch:
$ git checkout -b my-feature master
  • Hack on your feature with your favorite editor or IDE!
  • Commit and Push your changes up:
$ git add -A
$ git commit -m "my fancy new feature. Closes #xx"
$ git push -u origin my-feature

That's it! Six easy steps to contributing a new feature!

Generally we'll respond pretty quickly to new issues, pull requests and general discussions on IRC. So come and join us!

Reporting Bugs

Found a bug? Great! We wants to help fix it!

When describing your bug report; please be concise and as detailed as you can so we can easily work out what the problem is. It's also very helpful if you are able to provide a test case that repeatedly demonstrates the bug at hand:

Example:

from circuits import Event, Component


class test(Event):
    """test Event"""


class App(Component):

	message = None

    def started(self):
		self.message = "Hello World!"
		self.stop()


def test():
	App().run()

	assert app.message == "Hello World!"

Obviously this test would pass but this is ideally what we'd like to see bug reports in the form of; a reliable, repeatable way of demonstrating the bug.

If you don't feel comfortable writing a test case; a good description is enough! (We'll take care of the hard work of ensuring the bug never occurs again!)

Documentation

Please help us with Documentation

Our documentation is written in reStructuredText using the Sphinx documentation toolkit.

See: Documentation Sources

You can contribute in these easy steps:

  1. Navigate our Documentation Sources
  2. Find a document you wish to improve.
  3. Click on the Pen (Edit this file) button.
  4. Make your changes and submit a new Pull Request using the Github editor

See: Editing files in another user's repository

Community

This section includes ideas on how non-developers can help with the project. Here's a few examples:

  • You can help us answer questions our users have here: StackOverflow circuits-framework

  • You can help build and design our website here: circuitsframework.com

  • You can help write blog posts about the project by: sharing them with the Community

  • You can tweet about your use of circuits and tag @pythoncircuits

  • Create an example of the project in real world by building something or showing what others have built.

  • Write about other people’s projects based on this project. Show how it’s used in daily life. Take screenshots and make videos!

If you have further questions, contact: James Mills (@therealprologic