/foro-unimayor

Proyecto-foro-ingenieria de software

Primary LanguageJavaScriptMIT LicenseMIT

FUM logo

Foro universitario colegio mayor del cauca.

Table of contents

How to Contribute

Contributor Behavior

Be kind to one another. We're striving to make Conventional Commits an inclusive environment that's great for first time open-source contributors.

Conventional Commits use the GitHub flow as main versioning workflow

Setup Development Environment

  1. Fork the repository.
  2. Clone your forked repository to your local machine.
# HTTPS
git clone https://github.com/<your_profile_name>/foro-unimayor.git

# or SSH
git clone git@github.com:<your_profile_name>/foro-unimayor.git
  1. Install the dependencies.
  # using npm
  npm install
  1. setup the environment variables on .env file.

    NOTE: you can copy the .env.example file and rename itto .env. Don't forget to fill the variables with the correct values.

  2. Run the application.

  # using npm
  npm run dev

Pull Requests

  1. Extract the changes
git pull origin main # or vite 
  1. Create a new branch for each feature
# create a new branch and switch to it
git checkout -b <branch-name>
  1. Make your changes and commit them.
# add the changes
git add .
# commit the changes
git commit -m "your commit message"
  1. Merge the changes from to vite branch.
# switch to main branch
git switch  vite
# merge the changes from the feature branch
git merge <branch-name>
  1. Send a pull request from each feature branch to vite branch.
# push the changes to the remote repository
git push origin vite

License

License