Contributing to this project

Contributions to this project are always welcome. As a contributor, here are the guidelines we would like you to follow:

• Code of Conduct
• Feature Requests
• Issues and Bugs
• Submission Guidelines
• Coding Rules
• Commit Message Guidelines

Code of Conduct

Help keep this project open and inclusive. Please read and follow the Code of Conduct.

Feature Request

You can request a new feature by submitting an issue to our repository.

• For a Major Feature, open an issue first so it can be discussed.
• Small Features can be crafted and directly submitted as a Pull Request.

Submitting an Issue

Before submitting an issue, search the archive.

• Overview of the Issue
• Motivation or Use Case
• Browsers and Operating System
• Steps to reproduce
• Screenshots if relevant
• Related issues

Submitting a Pull Request (PR)

Before submitting your PR:

• Fork the repository
• Follow coding conventions
• Add unit and functional tests
• Run the linter
• Update the changelog

git push my-fork my-fix-branch

Then open a Pull Request to master.

After your pull request is merged

You can safely delete your fork and pull the updated main branch.

Coding Rules

• All features or bug fixes must include tests
• All public APIs must be documented
• Follow the PEP8 Python style guide

Commit Message Guidelines

Commit messages should describe what changed and reference the issue ID.

git commit -m "#178 Removes obsolete functions from base_app's views file"