Skip to content

Development Workflow

Alexander Klee edited this page Aug 24, 2021 · 1 revision

blockfrost-dotnet uses a feature driven development process.

Contribute

Developers cannot commit to main or staging (default). New features are developed on feature branches and merged into staging using Pull Requests.

All branches should be named using the following conventions:

  • feat/issue-{number} : use for application new features
  • bug/issue-{number} : use for fixing application bugs / issues

examples :

  • feat/issue-15469
  • bug/issue-15469

Developers should follow the following steps :

  • Updated the staging : git pull origin staging
  • create feature branch : git chekout -b feat/issue-1852
  • Develop the specified requirements
  • commit and Push the code : git push --set-upstream origin feat/issue-1852
  • Create a draft pull request and improve it until your code meets the PR Checklist
  • When ready, move the PR out of draft and ask a maintainer to review it
  • Address the required review comments
  • After the review a maintainer will squash-merge your PR

PR Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Releases

Release planning is done using version milestones. When staging reaches a milestone, the branch is merged into main and tagged to trigger the deployment builds.

Clone this wiki locally