Contributing

We welcome and appreciate any and all contributions. Any effort will be given due credit.

Types of Contributions

Submit Feedback

The best way to provide feedback is to open an issue here. When proposing a feature:

  • Explain in detail how it would work

  • Keep the scope as narrow as possible

Report Bugs

Please report bugs here. When reporting, please include:

  • Your operating system and version

  • The version(s) of the package dependency (or dependencies) that produce the bug

  • Detailed steps to reproduce the bug

  • Any details about your local setup that might be helpful in troubleshooting

Fix Bugs

Look through the GitHub issues for bugs. If you want to start working on a bug, please write a short message on the issue tracker to prevent duplicate work. Bugfixes should be submitted as pull requests.

Implement Features

Look through the GitHub issues for features. If you want to start working on an issue, please write a short message on the issue tracker to prevent duplicate work. Implemented features should be submitted as pull requests.

Write Documentation

IRSA could always use more documentation, or have existing documentation improved upon. These include the documentation you are reading now, docstrings, tutorials, or even on the web as blog posts or articles. Please reference the documentation guidelines below. Changes to documentation should be submitted as pull requests.

Submitting a Pull Request

To update the documentation, fix bugs, or add new features you need to create a pull request. Any changes you make to your local copy of the code will be made easily available for review and eventual integration into the code base. To create a pull request:

  1. Create a GitHub account

  2. Fork the repository

  3. Clone your fork locally

  4. Go to the created irsa folder with cd irsa

  5. Create a new branch with git checkout -b <descriptive_branch_name>

  6. Make your changes to the code or documentation

  7. Run git add -A to add all the changed files to the commit

  8. To commit the added files, run git commit -m '<text>' or git commit. The latter will open a command line editor to write a commit message. Commit messages should have a descriptive line header (<50 characters, including spaces), followed by an empty line, and then a description of what you did and why. We also ask that the header be of the style “This commit will <commit message>”, with the first letter capitalized and no trailing period. Please see existing commit history for examples.

  9. Push your changes to your irsa fork by running git push origin <descriptive_branch_name>

  10. If you then navigate to the webpage for your irsa fork, you should see a “Pull request” link in the sidebar. Choose the relevant pull request from the menu and click the “Create Pull Request” button. Ensure the pull request target branch is <descriptive_branch_name>!

If you want to create more pull requests, first run git checkout main and then start at step 5 with a new branch name.

Documentation Guidelines

Coming soon!

Testing Guidelines

Coming soon!