Skip to content

Latest commit

 

History

History
72 lines (54 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

72 lines (54 loc) · 3.47 KB
Raw

Contributing

Thanks for your interest in helping improve abtester! This guide is for people who want to contribute code to the project. There are other ways to contribute, such as reporting a bug or requesting a feature. You can also just ask a question, or join the discussions with the community. Note that we have a code of conduct, please follow it in all your interactions with the project.

Before starting

If your contribution is more than a few lines of code, then prior to starting to code on it please post in the respective issue saying you want to volunteer, and then wait for a positive response. If there is no issue for it yet, create it first. This helps make sure:

  • Two people aren't working on the same thing
  • This is something the project's maintainers believe should be implemented or fixed
  • Any API, UI, or deeper architectural changes that need to be implemented have been fully thought through by the project's maintainers
  • Your time is well spent!

Style guide

We use Black, with a line length of 80 characters, to format the code. Besides that, Streamlit's oficial style guide is followed throughout the project.

Development

Ensure you have Python 3.11+ and Pipenv installed.

  1. Fork the repository via the user interface on GitHub and then do the following:
git clone https://github.com/${YOUR_NAME}/abtester.git
cd abtester
git remote add remote https://github.com/gabrieltempass/abtester.git
git checkout develop
git submodule update --init
git checkout -b ${BRANCH_NAME}
  1. Create the Python virtual environment, install the dependencies and activate it:
pipenv install --dev
pipenv shell
  1. Run the Streamlit app:
streamlit run abtester.py

If all goes well, you should see something like this:

Quickstart success

  1. Modify the code and submit your pull request.