search

StatCan / openmpp

Implementing the OpenM++ microsimulation framework as a Kubernetes service on the StatCan cloud.
0 stars 1 forks source link

Contributing to OpenM++ Upstream - Guidelines Draft #39

Closed Souheil-Yazji closed 9 months ago

Souheil-Yazji commented 10 months ago

Requirements

StatCan IT needs a well-oiled framework for contributing development to OpenM++ upstream.

Creating Github Issues in the Approriate repository

To avoid any duplication of work and to inform OpenM of our intention to action a specific task, we can submit the contents of Jira tickets from our internal Jira to the Github repositories as issues. This opens the floor for discussion in an manner which offers many advantages over email, such as:

  1. Centralized Communication
  2. Integration with Code and Workflow
  3. Transparency and Accessibility
  4. Structured Discussions
  5. Notifications and Alerts
  6. Promotes Community Engagement
  7. Version Control and History
  8. Ease of Reference
  9. Project Management
  10. Developer-Friendly Environment

Submitting Work

We should be able to submit Pull Requests to the OpenM++ github repositories with our work to contribute to the OpenM++ ecosystem. Using pull requests will allow us and OpenM to collaborate in terms of conducting code reviews and evaluating the validity/necessity of changes. Pull Requests can also be linked to their associated Github Issue, and can be used to close said Issue.

Souheil-Yazji commented 9 months ago

Closing for now, to be revisited later.