Contributing

Repository Management

  • All new repositories should be created in the Greenland-Net github organization using the template.
  • If the repository is exploratory the name should be repo-exploration.
  • Repositories that are no longer in use should be archived promptly.
  • We strive to follow best practices to structure the repository for the given need. For example use the scientific python guide.

Code Contributions

  • Strive to create tests for all new features/bugfixes.
  • New or modified features should be accompanied by adequate documentation.
  • Follow the recommended git flow.

Code Review

  • Create pull requests liberally. Ideally each pull request implements a single feature tracked by an issue on the project board.
    • Make sure pull request is linked to related issue in the description.
  • Add other team members as reviewers on all pull requests.
    • Ping individual contributors on slack if their review is desired.
    • Wait for atleast one approval before merging.