CONTRIBUTING.md

Contributing

First, here are a few simple ways to help.

Star astrobase_cli on GitHub!

By adding a star, other users will be able to find Astrobase more easily and see that it has been already useful for others.

Watch astrobase_cli for new releases!

You can "watch" Astrobase in GitHub (clicking the "watch" button at the top right). There you can select "Releases only". Then you will receive notifications whenever there's a new release (a new version) of Astrobase with bug fixes and new features.

Connect with Astrobase

Follow the company.

Open a pull request or issue.

Issues and pull requests are very welcome!

---

Now if you already cloned the repository and you know that you need to deep dive in the code, here are some guidelines to set up your environment.

Use a virtual environment

$ python -m venv .venv

This will create a directory ./venv/ with python binaries and then you will be able to install packages for that isolated environment.

Next, activate the environment.

$ source ./venv/bin/activate

To check that it worked correctly;

$ which python pip
/path/to/cli/.venv/bin/python
/path/to/cli/.venv/bin/pip

pyenv is suggested for local python development.

Flit

Astrobase uses flit to manage our project's dependencies.

After activating the environment as described above, install flit:

$ pip install flit

Install dependencies

./scripts/install.sh

Formatting

./scripts/format.sh

Tests

./scripts/test-cov-html.sh

This command generates a directory ./htmlcov/, if you open the file ./htmlcov/index.html in your browser, you can explore interactively the regions of code that are covered by the tests, and notice if there is any region missing.