Skip to content

Improve contributing guide for issues and add micropython to FAQ #662

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
WasabiFan merged 1 commit into from
Aug 22, 2019
Merged

Improve contributing guide for issues and add micropython to FAQ #662

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 23 additions & 17 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,38 @@
Contributing to the Python language bindings for ev3dev
=======================================================

This repository holds the pure Python bindings for peripheral
devices that use the drivers available in the ev3dev_ distribution.
for embedded systems.
This repository holds the Python bindings for ev3dev_, ev3dev-lang-python.

Contributions are welcome in the form of pull requests - but please
take a moment to read our suggestions for happy maintainers and
even happier users.
Opening issues
--------------

The ``ev3dev-stretch`` branch
-----------------------------
Please make sure you have read the FAQ_. If you are still encountering your
problem, open an issue, and ensure that the questions asked by the issue
template are completely answered with correct info. This will make it much
easier for us to help you!

This is where the latest version of our library lives. It targets
``ev3dev-stretch``, which is currently considered a beta. Nonetheless,
it is very stable and isn't expected to have significant breaking
changes. We publish releases from this branch.
Submitting Pull Requests
------------------------

Before you issue a Pull Request
-------------------------------
Contributions are welcome in the form of pull requests - but please
take a moment to read our suggestions for happy maintainers and
even happier users.

Sometimes, it isn't easy for us to pull your suggested change and run
rigorous testing on it. So please help us out by validating your changes
and mentioning what kinds of testing you did when you open your PR.
Please also consider adding relevant tests to ``api_tests.py`` and documentation
changes within the ``docs`` directory.

The ``ev3dev-stretch`` branch
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This is where the latest version of our library lives. It targets
``ev3dev-stretch``, which is the current stable version of ev3dev.
We publish releases from this branch.

If your change breaks or changes an API
---------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Breaking changes are discouraged, but sometimes they are necessary. A
more common change is to add a new function or property to a class.
Expand All @@ -40,7 +45,7 @@ and can easily discuss the breaking change and add it to the release
notes.

If your change addresses an Issue
---------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Bug fixes are always welcome, especially if they are against known
issues!
Expand All @@ -51,7 +56,7 @@ to its relevant issue and will automatically close the issue when the
PR is merged.

Building and testing changes on the EV3
---------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In an SSH terminal window with an EV3 with Internet access,
run the following commands:
Expand Down Expand Up @@ -95,3 +100,4 @@ sudo apt install --only-upgrade micropython-ev3dev2
```

.. _ev3dev: http://ev3dev.org
.. _FAQ: https://python-ev3dev.readthedocs.io/en/ev3dev-stretch/faq.html
2 changes: 1 addition & 1 deletion docs/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Q: How can I upgrade the library on my EV3?
.. code-block:: bash

sudo apt-get update
sudo apt-get install --only-upgrade python3-ev3dev2
sudo apt-get install --only-upgrade python3-ev3dev2 micropython-ev3dev2

Q: Are there other useful Python modules to use on the EV3?
A: The Python language has a `package repository`_ where you can find
Expand Down