Contributing to Daily Focus

When contributing towards this project, ensure the Fork and Pull model is followed as outlined below.

Workflow

Step 1: Create a Fork

Fork this repository using the "Fork" button at the top right-hand side of this page to create your own server-side copy.

Step 2: Clone your Fork

Run the standard git clone command to create a local git repository from the remote fork on GitHub.

Example: git clone https://github.com/[USERNAME]/[FORKED_REPOSITORY].git

Step 3: Create Modifications

Create a new local feature branch associated to an open issue and make any necessary modifications. Commit these changes and include a brief and descriptive commit message. If the issue does not exist, create a new issue following these guidelines.

Example: git commit -m "[DESCRIPTION]"

Step 4: Push Necessary Changes

Push these changes to your remote fork on GitHub using the standard git push command.

Example: git push origin [FEATURE_BRANCH]

Step 5: Clean Up Feature Branch

Prior to submitting a pull request, if any changes were made to the upstream main branch be sure to rebase your feature branch first to avoid any conflicts.

Example:

1. Fetch upstream main and merge with local main: git fetch upstream, git checkout main, git merge upstream/main.

2. Rebase feature branch if there were new commits in upstream main: git checkout [FEATURE_BRANCH], git rebase main.

Step 6: Submit a Pull Request

Submit a Pull Request to merge the new feature branch to the 'official' server-side repository pending on assigned reviewers' approval.

For more details on what to include in a Pull Request, visit this page.