contributing.md

Contributing

Step 1. Fork this repository to your GitHub

Step 2. Clone the repository from your GitHub

git clone https://github.com/[YOUR GITHUB ACCOUNT]/pycontw-postevent-report-generator.git

Step 3. Add this repository to the remote in your local repository

git remote add upstream "https://github.com/pycontw/pycontw-postevent-report-generator"

You can pull the latest code in master branch through git pull upstream master afterward.

Step 4. Check out a branch for your new feature

git checkout -b [YOUR FEATURE]

Step 5. Install Prerequsite

python -m pip install pipx
python -m pipx install pipenv invoke
python -m pipx ensurepath

• pipx: for python tool management
• pipenv: for dependency management
• invoke: for task management

Step 6. Create Your Own Python Virtual Environment and Install Depdencies

inv env.init-dev

Step 6. Work on your new feature

[Optional] Step 7. Install Attendees Analyzer for local test

If you want to develop it, please run:

inv build.develop

Step 8. Run test cases

Make sure all test cases pass.

inv test

Step 9. Run test coverage

Check the test coverage and see where you can add test cases.

inv test.cov

Step 10. Reformat source code

Format your code through black and isort.

inv style.reformat

Step 11. Run style check

Make sure your coding style passes all enforced linters.

inv style

[Optional] Check your coding style through pylint. Note that you do not have to fix all the issues warned by pylint.

inv style.pylint

[Optional] Step 12. Run security check

Ensure the packages installed are secure

inv secure

[Optional] Check whether there is common security issue in the code. Note that you do not have to fix all the issues warned by bandit

inv secure.bandit

Step 13. Check the installed cli is runnable

inv build.test-cli

Step 14. Create a Pull Request and celebrate 🎉