Skip to content

Latest commit

 

History

History
65 lines (54 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

65 lines (54 loc) · 1.76 KB
Raw

Contribution Rules📚:

  • You are allowed to make more than one pull request. We'll merge surely merge the perfect ones :)
  • Do NOT add any build steps e.g npm install (we want to keep this a simple static site)
  • Do NOT remove other content.
  • Styling/code can be pretty, ugly or stupid, big or small as long as it works 😉
  • Make sure your create a separate branch before opening a PR.
  • Try to keep pull requests small to minimize merge conflicts

Getting Started 🤩🤗:

  • Fork the repository
  • Clone your forked repository:
git clone https://github.com/your-username/fsociety/
  • Navigate to the project directory:
cd fsociety
  • Install dependencies:
pip install -r requirements.txt
  • Start the Python module:
python -m fsociety3
  • Create a new branch for your contribution:
git checkout -b your-username
  • Make your changes and commit them:
git commit -m "Added a New Feature"
  • Push your changes to your fork:
git push origin your-username
  • Create a Pull Request to the main repository!
  • Get your PR merged 🚀

Avoid Conflicts {Syncing your fork}

An easy way to avoid conflicts is to add an 'upstream' for your git repo, as other PR's may be merged while you're working on your branch/fork.

git remote add upstream https://github.com/gdscsmit/fsociety/

You can verify that the new remote has been added by typing

git remote -v

To pull any new changes from your parent repository simply run

git merge upstream/main

This will give you any eventual conflicts and allow you to easily solve them in your repo. It's a good idea to use it frequently in between your own commits to make sure that your repo is up to date with its parent.