Make CONTRIBUTING docs - Githubissues

founderswap / swap-anything

A mix and match (swap) library to empower swapping-based projects.

MIT License

5 stars 0 forks source link

Make CONTRIBUTING docs #21

Open ggbaro opened 9 months ago

ggbaro commented 9 months ago

[ ] Code of conduct
[ ] Docs on how to make docs
- See: https://github.com/founderswap/swap-anything/issues/18#issuecomment-1843743096
[ ] List of good first issues
[ ] Finish this list of contents to include in CONTRIBUTING

LFK01 commented 8 months ago

A start point for contributions could be comments on the code.

For example I don't understand what is the code executed when the CLI command is invoked, I'm pretty sure I checked all the python files (mostly _base.py and airtable.py) and I haven't found any ArgumentParser or sys.argv call to parse CLI parameters.

Another idea for the contributing could be a little explanation on how the code is executed, from there I'll try to help as much as possible. Pardon my juniority :)