Contribution Guideline

Collaborations

Please feel free to contact us.

• Prof. Kevin Skadron - skadron AT virginia DOT edu

Release Management

• New releases will be created at this Releases page once the main branch reaches a stable milestone.
• Semantic versioning - MAJOR.MINOR.PATCH
  • Captures PIMeval API upgrades, PIMbench suite updates, etc.

Branch Management

• Main branch
  • In this PIMeval-PIMbench repo, the main branch is the stable branch with tight code control. Developers need to submit pull requests (PRs) and get code review approval before check in to this branch. All check-ins to main branch need to be thoroughly tested.
• Development branches
  • The dev-* branches are for collaborative development of various features. There is no PR or code review requirements, and collaborators are responsible for smooth and fast collaboration. If needed, one can still submit PRs and schedule code reviews for dev branches.
  • Once a dev-* branch reaches a good shape, i.e., when features are well designed, finalized, and tested, it can be merged into main branch.
• Personal branches and forks
  • Feel free to clone, fork, or create new branches for non-collaborative development activities.

Code Development

• Please see Developer Guide