CONTRIBUTING.rst

How to contribute to Pegelinux

Thank you for considering contributing to Pegelinux!

Support questions

Please, don't use the issue tracker for this. Use one of the following resources for questions about your own code:

• The Telegram group pegelinux .

Reporting issues

• Describe what you expected to happen.
• If possible, include a minimal, complete, and verifiable example to help us identify the issue. This also helps check that the issue is not with your own code.
• Describe what actually happened. Include the full traceback if there was an exception.
• List your Python, Flask versions. If possible, check if this issue is already fixed in the repository.

Submitting patches

• Try to follow PEP8, but you may ignore the line length limit if following it would make the code uglier.
• Or run inv clean to run black as pep8 formatter

First time setup

• Download and install the latest version of git.

• Configure git with your username and email:

  git config --global user.name 'your name'
  git config --global user.email 'your email'
  

• Make sure you have a GitHub account.

• Fork pegelinux to your GitHub account by clicking the Fork button.

• Clone your GitHub fork locally:

  git clone https://github.com/{username}/pegelinux
  cd pegelinux
  

• Add the main repository as a remote to update later:

  git remote add pegelinux https://github.com/nsiregar/pegelinux
  git fetch pegelinux
  

• Use pipenv:

  pipenv install
  pipenv shell
  

Start coding

• Create a branch to identify the issue or feature you would like to work on (e.g. basic-test-suite)
• Using your favorite editor, make your changes, committing as you go.
• Try to follow PEP8, but you may ignore the line length limit if following it would make the code uglier. Or just run inv clean.
• Push your commits to GitHub and create a pull request.
• Celebrate 🎉