Contributing to pyufunc#

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.

Bug reports and enhancement requests#

Bug reports and enhancement requests are an important part of making pyufunc more stable and are curated though Github issues. When reporting an issue or request, please select the appropriate category and fill out the issue form fully to ensure others and the core development team can fully understand the scope of the issue.

The issue will then show up to the pyufunc community and be open to comments/ideas from others.

Finding an issue to contribute to#

If you are brand new to pyufunc or open-source development, we recommend searching the GitHub “issues” tab to find issues that interest you.

Once you’ve found an interesting issue, it’s a good idea to assign the issue to yourself, so nobody else duplicates the work on it. On the Github issue, a comment with the exact text take to automatically assign you the issue (this will take seconds and may require refreshing the page to see it).

If for whatever reason you are not able to continue working with the issue, please unassign it, so other people know it’s available again. You can check the list of assigned issues, since people may not be working in them anymore. If you want to work on one that is assigned, feel free to kindly ask the current assignee if you can take it (please allow at least a week of inactivity before considering work in the issue discontinued).

Submitting a pull request#

Version control, Git, and GitHub#

pyufunc is hosted on GitHub, and to contribute, you will need to sign up for a free GitHub account.

If you are new to Git, you can reference some of these resources for learning Git. Feel free to reach out to the community for help if needed:

Also, the project follows a forking workflow further described on this page whereby contributors fork the repository, make changes and then create a pull request. So please be sure to read and follow all the instructions in this guide.

If you are new to contributing to projects through forking on GitHub, take a look at the GitHub documentation for contributing to projects. GitHub provides a quick tutorial using a test repository that may help you become more familiar with forking a repository, cloning a fork, creating a feature branch, pushing changes and making pull requests.

Below are some useful resources for learning more about forking and pull requests on GitHub:

Getting started with Git#

GitHub has instructions for installing git, setting up your SSH key, and configuring git. All these steps need to be completed before you can work seamlessly between your local repository and GitHub.

Create a fork of pyufunc#

You will need your own copy of pyufunc (aka fork) to work on the code. Go to the pyufunc project page and hit the Fork button. Please uncheck the box to copy only the main branch before selecting Create Fork. You will want to clone your fork to your machine