Skip to content

Contribution process

General contribution flow

  1. Make a fork of https://github.com/epicfaace/CFF/.

  2. Create your own branch with the new changes.

  3. Make a pull request to the main repository.

  4. Once the pull request is approved, it will be merged into master.

Git and VS Code tutorial

  1. Open the CFF project using Visual Studio Code. image

  2. Select the file you want to make changes to: image

  3. Make sure you are currently on the "master" branch. Click on the "sync" icon to pull the latest changes from master on GitHub to your local repository. image
  4. Create a new branch for the functionality you are about to code and give it a descriptive name (for example, "NewButtonAdd"). image
  5. Make sure you have switched to the new branch that you just created before making the code changes. image
  6. Once you make the changes, the pending changes will show up in the VS Code window. Click on the "Commit changes" icon (check mark). This saves the changes to the local branch. image
  7. Click on the "Publish Changes" icon at the bottom. This creates a new branch in GitHub and publishes your changes to it. You can also select the "..." button and select the "Push" menu to push the code to GitHub. image
  8. Create a new pull request from the GitHub repository to the master branch. Choose two branches to see what's changed or to start a new pull request. image
  9. Add screenshots/details of the changes to the new pull request and send it for approval.
  10. Once another developer approves the request, you can merge the pull request to Master so the changes will show up in Master image image
  11. Remember to delete the branch in Github once the changes are merged to master.
  12. The final step is make sure you go back to the master branch in the VS Code project and sync it so that the changes show up on your local version of master.