Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.94 KB

Contributing a patch

The steps to contribute a change are:

  1. Fork the IronPython3 repository. For more information see Getting the Sources.
  2. Build the repository. For more information see Building.
  3. Make your changes on your machine, ensure make.ps1 test-all runs successfully, and commit your changes. For more information see Modifying the Sources.
  4. Push the commits to your fork. This way your name will be the author of the commit in the main IronPython3 tree (once the commits are pulled into the main tree).
  5. Create a pull request on Github, this will initiate a code review and CLA signing request
  6. The IronPython team will review, and possibly request changes, to your PR
  7. Once all comments/questions/concerns have been addressed, your PR will be merged.

Also, Collaborative Github Workflow has a very good description of the workflow and tips and tricks when contributing to a project hosted on GitHub.

Ideas for contributions

For our first release, we are currently aiming for a Python 3.4 compatible version of IronPython. To that end we have created checklists in order to help keep track of what remains to be done:

Suggestions for first time contributors:

  • Updating documentation (such as checking off completed features in the above lists).
  • Trying out failing tests to identify and/or fix the cause of the failures.
  • List of good first issues.