Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (65 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

100 lines (65 loc) · 3.12 KB

Contributing

Contribute to this repository by adding your name to the list of participants of the event you are attending.

1. Fork the playground-zurich with your GitHub account

fork

2. Clone your forked repo to your local environment

git clone https://github.com/<your-username>/playground-zurich.git
cd playground-zurich

3. Set up the origin and upstream of your local project

# Add the "upstream" to your cloned repository
git remote add upstream https://github.com/python-sprints/playground-zurich.git

# Set the "origin" url to your cloned repository
git remote set-url origin https://github.com/<your-username>/playground-zurich.git

4. Work in a new branch of your origin

# 1) Create and switch to a new branch (e.g. `add-my-name`) from your origin/main branch
git branch add-my-name origin/main
git checkout add-my-name

# 2) Add your name to the list of participants of the event you are attending

# 3) Add the modified files and make a commit (e.g. you changed events/2025-06-16.md)
# NOTE: Make sure to only commit relevant files!
git add events/2025-06-16.md
git commit -m 'Add my name to the list of participants'

# 4) Push to your branch
git push origin add-my-name

5. Make a pull request on GitHub

  • Go to the add-my-name of your forked project on Github
  • Click Compare & pull request
  • Leave a comment

See a PR example here!

6. Delete branch locally and/or remotely after pull request is merged on GitHub

  • Deleting your local branch from the command line: git branch -d add-my-name
  • Additionally if you want to delete your remote branch: git push origin :add-my-name

7. (in case you need it) Synchronize with updates from the upstream

Sometimes you may need to update your fork with the latest changes from the upstream. This may happen when, for example, the main branch was updated since you opened your PR and contains conflicts with your changes.

# 1) Go to the "add-my-name" branch of your fork ("origin")
git checkout add-my-name

# 2) Fetch the commits from the "upstream"
git fetch upstream

# 3) Merge the changes from the "main" branch of the "upstream" into your "add-my-name" branch of your "origin"
git merge upstream/main

# 4) Resolve merge conflicts if any and commit your merge
git commit -m "Merged from upstream"

# 5) Push the changes to your fork ("origin")
git push

PR review rules

The project require the approval from one reviewer to merge the pull request. Please tag @EdAbati to review your PR.

Issue guidelines

New issue

Any issue in the documentation? Here's what you need to do when you want to create a new issue:

  • Search if the issue has already been created.
  • If yes and open refer to existing issue.
  • If yes and closed reopen issue with descriptive comment.
  • If no, create the issue. :)

Existing issue

  • Read comments.
  • Find out if anyone is working on it, if no, offer to do it. If yes, see if you can be of help.

References

Main resource: https://github.com/python-sprints/pandas-mentoring/blob/master/contributing.md