Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

44 lines (26 loc) · 1.3 KB

Contributing to awsimple

Hi! First of all, thank you for contributing. ❤️

All of the usual sorts of contributions are welcome: bug reports, patches, and feedback. Feel free to browse existing issues or create a new one.

Got a problem?

You're welcome to create an issue, but please search existing ones first to see if it's been discussed before.

Want to submit some code or docs?

Great!

If you're intersted in tackling an existing issue, comment on one to make sure you're on the right track. If it's an idea you have or a problem not captured in an issue, create one and let's align.

Dev setup

Requirements:

  • Python 3.8 or higher

Fork the repo, to make your own personal copy, and then git clone your fork onto your computer.

Once you have that, install project dependencies with:

Mac / Linux

source make_venv_dev.sh
./venv/bin/activate

Windows

make_venv_dev.bat
.\venv\Scripts\activate.bat

At this point you should be able to make changes to the codebase and run things.