Skip to content

Latest commit

 

History

History
97 lines (66 loc) · 6.06 KB

contributing.md

File metadata and controls

97 lines (66 loc) · 6.06 KB

Contributing to CODE PDX WEBSITE

Contents

  1. Project Summary
  2. Tech Stack & Resources
  3. Code of Conduct
  4. Connect With the Team
  5. Development Process

1. Project summary

Building a new CODE PDX website with react and vite, current planning is for a static 3 page site. All assets for contributors can be pulled from the Figma Board

2. Tech Stack & Resources

3. Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please make sure to read and understand it before contributing.

4. Connect With the Team

5. Development Process

  • Github Issues

  1. Search through open issues.
  2. Find an issue that interests you.
  3. Check if someone is currently working on that issue and if a pull request exists. If someone is working on an issue they should also have a branch created for it and be assigned to the issue.
  4. Assign yourself to an issue leave a comment stating your plans and create a branch for your issue.

  • All bug reporting, feature requests, or enhancements can be found in issues

  • Templates for each one can be found here in the .github/ISSUE_TEMPLATE folder. These will automatically populate when using github issues.

  • Clone the repo

  1. Clone repo to local environment in IDE of choice. If you are new to Git/GitHub you can also check out this article for a broad overview.

    • Open terminal & change working directory to the location you want the repository cloned to.
    • gh repo clone codeforpdx/codepdx_website learn more about git clone This will set the git origin to https://github.com/codeforpdx/codepdx_website. By default the branch is set to Main. learn more about git remote
    • Change directory to the cloned directory, in this case /codepdx_website: cd ./codepdx_website
    • Origin can be verified by running git remote -v which should show: 
      origin https://github.com/codeforpdx/codepdx_website.git (fetch)
origin https://github.com/codeforpdx/codepdx_website.git (push)

  2. Create a new branch to work on your feature (We recommend doing this via terminal) Branches should all be based off of main:

    • git checkout -b "<your branch name>" learn more about git branches using the recommended naming convention:<issue number><branch name> with a concise title.

    Example: 112/delete-client-modal

This can also be done directly from an issue in GitHub with the following steps. If done manually via command line, link branch to corresponding GitHub issue.

A. Create a branch by clicking create a branch under main within the issues page.

How to create a branch screenshot

B. Here you can change the branch source, the default should be main. Click Create branch to get started.

Screenshot to create branch

  • Work on feature in your own branch.

  • When feature is ready:

    • run git add . to add all changed files in commit. or git add <fileName> to include an individual file.
    • run git commit -m "some message abut changes in commit" with a concise message to describe what changes are included in the push.
    • push to GitHub in terminal: git push origin <your branch name>

  • Submitting a Pull Request

    If you are new to GitHub and/or the team, feel free to make your first pull request on the README/Contributing documentation to familiarize yourself with the project and GitHub. Add any comments and/or feedback and request reviews.

  • Make a pull request to the main branch. Request reviews from members of the team - you’ll need their approval to merge. **Make sure to close your branch once merged.

  • Code Styling/Linting

    Website code is formatted with ESLint and Prettier. see repo prettierrc.js and eslintrc.cjs for formatting settings. They are included as dependencies and will be installed while following the instructions of the readme. To lint your changes with ESLint follow the instructions

⬆️ Back to Top