Gitflow

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

For creating branches, we prefer to format it this way: [ISSUE-TAG]/[ISSUE-NUMBER]-[A-MEANINGFUL-TITLE].

So for example, we have an issue called "Update README" with a tag of "enhancement" and issue number of 1, the ideal branch name could be: enhancement/1-update-readme

Steps for Contributing with the "fork-and-pull" workflow:

  1. Fork the repo on GitHub.

  2. Clone the project to your own machine.

  3. Commit changes to your own branch.

  4. Push your work back up to your fork.

  5. Submit a Pull request so that we can review your changes.

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Examples

1 PR per Task On DEWORK

  • chore: add Oyster build script

  • docs: explain hat wobble

  • feat: add beta sequence

  • fix: remove broken confirmation message

  • refactor: share logic between 4d3d3d3 and flarhgunnstow

  • style: convert tabs to spaces

  • test: ensure Tayne retains clothing

# 1. Create a branch off of master

Choose a task from the current sprint. Navigate to code repository & fork Name the branch with your first name pre-pended: roy/location-aware-privacy-first

# 2. Writing code

Code solution in the fork Merge the solution with the test env Run tests on the code Make any necessary corrections

# 3. Create a pull request on Github

Include the Dework task link in your PR description.

# 4. Submit for review

Assign the task in Dework to the reviewer. Ask feedback Receive Validation Feedback + Iterate

# 5. Merge & Celebrate

Merge the test environment and Celebrate

PreviousFair LaunchNextAudit

Last updated