Skip to content

Latest commit

 

History

History
165 lines (104 loc) · 6.73 KB

CONTRIBUTING.md

File metadata and controls

165 lines (104 loc) · 6.73 KB

Welcome to Python Training contributing guide

Thank you for investing your time in the python training and contributing to our project! ✨.

In this guide you will get an overview of the contribution workflow.

Contributing Guidelines 👨‍💻

👨‍💻 Prerequisite Skills to Contribute

Contribute in public/Profile

Contribute in Documents

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

Since all of you have Anaconda installed on your system, we need to check if git too is availble on your system. Open Anaconda Navigator, and launch Powershell

image

When the shell is open, Type the command git --version
You should see an output similar to the screenshot below.



image

Issues

Look for a suitable issue

Go to the tab, and look for a issue you would like to address, open the issue and add a comment that you would like to contibute to this issue to let the maintainer know that you are working on it, and what exactly you are doing. make sure someone else is not already doing the same thing.

Sign up for Github

To contribute to this as well as to check out millions of amazing projects, you will need to sign up for github, which is a clowd implementation of git. You can use this as a backup for you repositories and save them from accedental deletion.

💥 How to Contribute

PRs Welcome Open Source Love

  • Take a look at the existing Issues or create a new issue!
  • Fork the Repo. Then, create a branch for any issue that you are working on. Finally, commit your work.
  • Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.
  • Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.

⭐ HOW TO MAKE A PULL REQUEST:

1. Start by making a Fork of the python-training repository. Click on the Fork symbol at the top right corner.

2. Clone your new fork of the repository in the terminal/CLI on your computer with the following command:

git clone https://github.com/<your-github-username>/python-training

3. Navigate to the newly created LinkFree project directory:

cd python-training

4. Set upstream command:

git remote add upstream https://github.com/<your-github-username>/python-training.git

5. Create a new branch:

git checkout -b YourBranchName

6. Sync your fork or your local repository with the origin repository:

  • In your forked repository, click on "Fetch upstream"
  • Click "Fetch and merge"

Alternatively, Git CLI way to Sync forked repository with origin repository:

git fetch upstream
git merge upstream/main

Github Docs for Syncing

7. Make your changes to the source code.

8. Stage your changes and commit:

⚠️ Make sure not to commit package.json or package-lock.json file

⚠️ Make sure not to run the commands git add . or git add *. Instead, stage your changes for each file/folder

git add public
git commit -m "<your_commit_message>"

9. Push your local commits to the remote repository:

git push origin YourBranchName

10. Create a Pull Request!

11. Congratulations! You've made your first contribution to python-training! 🙌🏼

🏆 After this, the maintainers will review the PR and will merge it if it helps move the all-round-calculator project forward. Otherwise, it will be given constructive feedback and suggestions for the changes needed to add the PR to the codebase.


Style Guide for Git Commit Messages 📝

How you can add more value to your contribution logs:

  • Use the present tense. (Example: "Add feature" instead of "Added feature")
  • Use the imperative mood. (Example: "Move item to...", instead of "Moves item to...")
  • Limit the first line (also called the Subject Line) to 50 characters or less.
  • Capitalize the Subject Line.
  • Separate subject from body with a blank line.
  • Do not end the subject line with a period.
  • Wrap the body at 72 characters.
  • Use the body to explain the what, why, vs, and how.
  • Reference Issues and Pull Requests liberally after the first line.

💥 Issues

In order to discuss changes, you are welcome to open an issue about what you would like to contribute. Enhancements are always encouraged and appreciated.

All the best! 🥇

built with love