Contribution Guidelines

Before contributing

Welcome to einsteinpy-geodesics! Before contributing to the project, make sure that you read our code of conduct.

These are some succint steps to set up a development environment and contribute to EinsteinPy Geodesics:

Install git on your computer.
Register to GitHub.
Fork einsteinpy_geodesics.
Clone your fork.
Install it in development mode, using: flit install --symlink /path/to/einsteinpy_geodesics/ (on *nix) or flit install --pth-file /path/to/einsteinpy_geodesics/ (on Windows). This means, that the installed code will change as soon as you change it in the download location.
Create a new branch from master: git switch -c new-branch master.
Make your code changes.
Check that your code follows the style guidelines of the project: tox -e reformat && tox -e check
Run the tests: tox -e py37. Change the version number according to the Python version, you are using.
Push to your fork.
Open a pull request!

If you find anything that doesn't work as expected or have suggestions, please refer to the issue tracker on GitHub.

Complete API Reference for the package can be accessed at Read the Docs.