Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

24 lines (18 loc) · 1.24 KB

Contributing to Ignite

If you are interested in contributing to Ignite, your contributions will fall into two categories:

  1. You want to propose a new feature and implement it
    • Post about your intended feature, and we shall discuss the design and implementation. Once we agree that the plan looks good, go ahead and implement it.
  2. You want to implement a feature or bug-fix for an outstanding issue
    • Look at the outstanding issues here: https://github.com/pytorch/ignite/issues.
    • Pick an issue and comment on the task that you want to work on this feature.
    • If you need more context on a particular issue, please ask and we shall provide.

Once you finish implementing a feature or bugfix, please send a Pull Request to https://github.com/pytorch/ignite

If you are not familiar with creating a Pull Request, here are some guides:

Writing documentation

Ignite uses Google style for formatting docstrings. Length of line inside docstrings block must be limited to 80 characters to fit into Jupyter documentation popups.