Skip to content

Latest commit

 

History

History
45 lines (23 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

45 lines (23 loc) · 1.73 KB

Contributing to PyroNear

Everything you need to know to contribute efficiently to the project.

Codebase structure

  • pyronear - The actual PyroNear library
  • references - Scripts to reproduce performances
  • test - Python unit tests

Continuous Integration

This project uses the following integrations to ensure proper codebase maintenance:

  • CircleCI - run jobs for package build and coverage
  • Codacy - analyzes commits for code quality
  • Codecov - reports back coverage results

As a contributor, you will only have to ensure coverage of your code by adding appropriate unit testing of your code.

## Issues

Use Github issues for feature requests, or bug reporting. When doing so, use issue templates whenever possible and provide enough information for other contributors to jump in.

## Code contribution

In order to contribute to the project,

  • Fork the repository
  • Create a new branch with the name of your feature
  • Make your commits (remember to add unit tests for your code)
  • When satisfied with your branch, open a PR from your fork

Commits

  • Code: ensure to provide docstrings to your Python code. In doing so, please follow Google-style so it can ease the process of documentation later.
  • Commit message: please follow Udacity guide