Contributing

• 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 main branch
    • Release a new version
• What to contribute?
  • 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
  • Notebooks
• Repository
  • Commits
  • Tags
  • Changelog
  • Package requirements for development
  • Makefile
  • Gitlab CI/CD pipeline
  • Package structure
• Policies
  • Version policy
• 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