Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 1.12 KB
Raw

Contributing to stella

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to stella, which is hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Setup Development Environment

This section shows how you can setup your development environment to contribute to stella.

  • Fork the repository.
  • Clone it using Git (git clone https://github.com/<YOUR USERNAME>/stella.git).
  • Create a new git branch (git checkout -b "BRANCH NAME").
  • Execute pip install -e . to install all the dependencies and make an editable install.
  • Make changes.
  • Stage and commit (git add . and git commit -m "COMMIT MESSAGE").
  • Push it to your remote repository (git push).
  • Open a pull request by clicking here.

Reporting Issues

If you know a bug in the code or you want to file a feature request, open an issue. Choose the correct issue template from here.