Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
106 lines (75 loc) · 4.57 KB

CONTRIBUTING.md

File metadata and controls

106 lines (75 loc) · 4.57 KB

Contributing to PeekingDuck

Code of Conduct

Please take a look at our code of conduct and adhere to the rules. Note that actions will be taken against individuals who violate our rules.

Types of Contribution

Help us keep discussions focused by checking if there already exists a thread pertaining to your issue before creating a thread. Duplicate threads will be redirected to existing ones.

Report a Bug

Create an issue on our issues tracker and tag the issue as a bug. In the issue, please provide a short description of the bug and the steps required to replicate it.

Useful Information

  • Operating System (mac/win/linux)
  • Python Environment (venv/pyenv)
  • Step by step information to recreate the bug

Community Discussions

Join us in our discussion board. Post your thread regarding

  • Questions on the project
  • Suggestions/features requests
  • Projects built using our project

Code Contributions

Here is a guide of the general steps to contribute code to PeekingDuck.

  • Own an issue from the issues board. This is to prevent duplicate work.

    1. Pick an issue from our issues tracker and indicate your interest to work on the issue.
    2. If there are no one else working on the issue, the maintainer will assign the issue to you.
    3. After receiving the confirmation from the maintainer, you may begin work on the issue.

  • Contributing Code

    1. Do read our code styles guidelines.
    2. Fork the aimakerspace/PeekingDuck repository. For more details in this process, Jake Jarvis has a useful guide that describes steps 2-6 and 10 in more detail.
    3. Clone the forked branch to your local machine.
    4. [Recommended] track the original repository as another remote. After which you will be able to receive updates using git fetch. This is useful for long term contributions to the repository.
    5. In your local repository, create a descriptive branch to work on your issue.
    6. Make the required changes within the branch.
    7. Add tests (if possible).
    8. Run the test suite and check that it passes.
    9. Push the changes to your github remote.
    10. Send us a pull request to PeekingDuck/dev.
    11. Make changes requested by your reviewer (if any).

Thank you for your contribution!!

Code Styles

Help us maintain the quality of our project by following the conventions we take below.

Git Commit Messages

This is a shortened version inspired by angular's contributing docs.

A standard git commit message helps us structure the project.

<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: core|cli|changelog|packaging|models|heuristics|cicd-infra|docs-infra|community
  │
  │
  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test

The <type> and <summary> fields are required, we encourage filling the (<scope>) field where possible.

Project Conventions

The following conventions are adopted to help maintain code consistency.

  • PEP8 convention
  • PEP484 type hinting for functions and methods
  • Absolute imports instead of relative imports

Test Suites

The project uses tools like pylint, pytest and bandit to maintain project quality. To run the test in mac use sh (for linux use bash).

sh scripts/linter.sh        # pylint for pep8 and code consistency
sh scripts/bandit.sh        # bandit to check for security related issues on dependencies
sh scripts/check_type.sh    # mypy to check for type hints on function/method level
sh scripts/unit_tests.sh    # pytest unit test for individual components
sh scripts/usecase_tests.sh # check standard usecase to ensure it is not broken

NOTE - linter, bandit, check_type runs on every pull request