Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

Latest commit

 

History

History
62 lines (38 loc) · 2.35 KB

howToContribute.md

File metadata and controls

62 lines (38 loc) · 2.35 KB
Raw

Learn How To Contribute

Table of Contents

Ways to contribute

These are the main ways to contribute to this project:

  • opening an issue
  • proposing a new feature idea or enhancement
  • writing documentation
  • fixing bugs

For more information, visit Code Contributions documentation on the Fractal website.

Dev Workflow

  1. If you haven't done so already, start by setting up your local environment.

  2. Branch off of the campus branch to make sure you have the latest updates.

  • Prefix your branch name with "CL-" and the corresponding issue number. e.g. If you are working on issue #30 Accordion bug, name your branch "CL-30-accordion-bug”.
git checkout -b CL-{{issue number}}-{{new branch name}}

  1. All edits should be made in the /src/ folder. See more information about the project directory.

  2. After making your changes locally, [commit your changes]((https://www.atlassian.com/git/tutorials/saving-changes/git-commit) so others have a log of your updates. Please be sure to add a commit message that will clearly underline the changes being made.

git commit -am "{{description of your updates}}"
  1. Push your new branch to the remote repository.
git push --set-upstream origin CL-{{issue number}}-{{new branch name}}
  1. If you've already pushed your current branch, you might just need to push your changes.
git push
  1. When you have completed your work, submit a pull request (PR) and set the destination branch to campus Be descriptive in your answers. The review process will begin and feedback (if any) will be added to the pull request.

⬅️ Go Back to Main README