Contributing

Contributions to this package can come in the form of issues (feature requests, bugs, etc.) but also in the form of direct code contribution.

• How to interact with the issue tracker?
  • Properly describe the issue
  • Analyze the issue
  • Assign the issue
  • Close the issue
• How to contribute?
  • Setup environment
  • Development
    • Identify an issue
    • Create temporary branch
    • Working on temporary branch
    • Merging branch on common dev branch
    • Release a new version
• What to contribute?
  • Package organization
    • User API
    • Internal API
    • Notable differences
  • Coding conventions
    • Type hinting
    • Linters
    • A note on floating point precision
    • Backward compatibility
  • Code documentation
    • Doc strings
    • References
    • Type hinting in doc
    • Comments
    • Example
  • Tests
    • Unit testing
    • Tests on multiple python versions
    • Coverage testing
    • Retrocompatibility tests
  • Notebooks
• Repository
  • Commits
  • Tags
  • Changelog
  • Package requirements
  • Makefile
  • Gitlab CI/CD pipeline
  • Package structure
• Policies
  • Version policy
  • Python support
    • Python version subsequent changes
• Contributors guides
  • Git functionalities
    • Clone a remote git repository
    • Set-up username and email
    • Set up mergetool and difftool
    • Create feature or hotfix branches
    • Keep local branches up-to-date
    • Work on feature or hotfix branch
    • Rebase of your branch
    • Merge changes on common branch
    • Repurpose an outdated branch
    • Release a new version
  • Python environments
  • Our linters
    • flake8
    • isort
    • black
    • mypy
  • Implementation recipes
    • Split implementation/user modules
    • Breaking changes in dependency
    • Changes brought by newer python versions
    • Deprecation recipes
      • Replace function/class by a new one
      • Rename function
      • Rename class
      • Change function/class API
      • Change function/class behaviour
• Contribution complete example