Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 3.25 KB
Raw

We welcome contributions to PYNQ. Please first sign our Contributor License Agreement.

If you have an idea how to improve PYNQ:

  1. Share your proposal via Github issues.

    A general set of rules on what to submit:

    1. We welcome submissions to the pynq Python package, sdbuild flows and documentation.

    2. For development boards, we only host boards that we officially support. To build new SDCard images for custom PYNQ enabled boards, we encourage users to build a new board-only repository. For reference, please see the Avnet Ultra96 or Xilinx ZCU111 repositories.

    3. For custom overlays, we only host overlays that we officially support. To create new custom overlays, we encourage users to build a new overlay repository. For reference, please see the PYNQ-HelloWorld and BNN-PYNQ repositories.

    4. For Microblaze peripheral drivers, we encourage users to submit their C/C++ within a Jupyter notebook using the microblaze IPython magic. Please see the Microblaze example notebooks for how to write custom device drivers.

  2. Submitting your pull request:

    1. Fork this repository to your own github account using the fork button above.

    2. Clone the fork to a local computer using git clone. Checkout the branch you want to work on.

    3. You can modify the Vivado projects, Python source code, or notebooks.

    4. Modify the documentation if necessary.

    5. Make sure your patch follows code standards:

      1. C/C++ code
      2. Python / Jupyter notebook

    6. Use git add, git commit, git push to add changes to your fork.

    7. Submit a pull request by clicking the pull request button on your github repo:

      1. The master branch should always be treated as stable and clean. Only hot fixes are allowed to be pull-requested. The hot fix is supposed to be very important such that without this fix, a lot of things break.
      2. For new features, small bug fixes, doc updates, and many other fixes, users should pull request against the development branch, which has the newest image version. For example, if we have released image v2.3 but you see a new branch image_v2.4, then you should pull request against image_v2.4 branch.

    Check the guide to git for more information.

  3. We will review your contribution and, if any additional fixes or modifications are necessary, may provide feedback to guide you. When accepted, your pull request will be merged to the repository.