How To Contribute¶
Start contributing today!
Introduction¶
Below is the workflow for having your contribution accepted into the pattoo
repository.
Create an Issue or comment on an existing issue to discuss the feature
If the feature is approved, assign the issue to yourself
Fork the project
Clone the fork to your local machine
Add the original project as a remote (git remote add upstream https://github.com/PalisadoesFoundation/pattoo, check with: git remote -v)
Create a topic branch for your change (git checkout -b
BranchName
)you may create additional branches if modifying multiple parts of the code
Write code and Commit your changes locally. An example of a proper
git commit
message can be seen below:When you need to synch with upstream (pull the latest changes from main repo into your current branch), do:
git fetch upstream
git merge upstream/master
Check for unnecessary white space with
git diff --check
.Write the necessary unit tests for your changes.
Run all the tests to assure nothing else was accidentally broken
Push your changes to your forked repository (git push origin
branch
)Perform a pull request on GitHub
Your code will be reviewed
If your code passes review, your pull request will be accepted
Code Style Guide¶
For ease of readability and maintainability code for all pattoo
projects must follow these guidelines. Code that does not comply will not be added to the master
branch.
- All
pattoo
projects use the Google Python Style Guide for general style requirements - All
pattoo
python projects use the The Chromium Projects Python Style Guidelines for docstrings. - Indentations must be multiples of 4 blank spaces. No tabs.
- All strings must be enclosed in single quotes
- In addition too being
pylint
compliant, the code must be PEP8 and PEP257 compliant too. - There should be no trailing spaces in files
Guidelines to remember¶
- Always opt for the most pythonic solution to a problem
- Avoid applying idioms from other programming languages
- Import each module with its full path name. ie: from pack.subpack import module
- Use exceptions where appropriate
- Use doc strings
- Try not to have returns at multiple points in a function unless they are failure state returns.
- If you are in the middle of a development session and have to interrupt your work, it is a good idea to write a broken unit test about what you want to develop next. When coming back to work, you will have a pointer to where you were and get back on track faster.
Commits¶
The pattoo
projects strive to maintain a proper log of development through well structured git commits. The links below offer insight and advice on the topic of commit messages:
Sample .vimrc File for Compliance¶
You can use this sample .vimrc file to help meet our style requirements