Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 4.98 KB

CONTRIBUTING.md

File metadata and controls

78 lines (60 loc) · 4.98 KB
Raw

Welcome to Python Lectures contributing guide

Thank you for investing your time in contributing to our project!
Any contribution you make will be reflected on our repo✨.
Big contributions will make your name listed on Acknowledgments

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open-source contributions:

Getting started

Step 1: Types of contributions

You can contribute to our notebook in several ways.
This repo is a place to discuss and collaborate on python related lessons !
Our small, but mighty 💪 team is maintaining this repo.

📣 Discussions

Discussions are where we have conversations. If you have a great new idea or want to share something amazing you've learned in our docs, join us in discussions.

🐞 Issues

Issues are used to track tasks that contributors can help with. If you've found something that is missing in the notebook or noticed a bug, search open issues to see if someone else has reported the same thing.
If it's something new, open an issue using a template.
We'll use the issue to have a conversation with you about your issue.

🛠️ Pull requests

A pull request is a way to suggest changes in our repository.
When we merge those changes, your changes will apply immediately to our main repo.

📖 Adding content

You can add content to our notebook, at this time were aiming to make a complete python tutorial with some additional information.
you can help us achieve this goal.

Step2: Choose what to do

  • solve an issue Scan through our existing issues to find one that interests you.
    If you find an issue to work on, you are welcome to open a PR with a fix.

  • Add more content (more details mentioned above)

Step3: Make Changes

Make changes locally

  1. Fork the repository.
  1. Install dependencies using pip3 install -r requirements.txt
  2. Create a working branch and start with your changes!

Step4: Commit your update

Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process:zap:

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill out the PR template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one. Once you submit your PR, a team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can make any other changes in your fork, then commit them to your branch.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 Our team thanks you ✨.
Once your PR is merged, your contributions will be publicly visible on the Contributors bar in our repo or here Now that you are part of our community. Congrats and well done 🎉.