Skip to content

Latest commit

 

History

History
129 lines (86 loc) · 4.88 KB

CONTRIBUTING.md

File metadata and controls

129 lines (86 loc) · 4.88 KB
Raw

⭐ First time contributing?

Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:

Contributing Guidelines👩‍💻👨‍💻

This documentation contains a set of guidelines to help you during the contribution process. When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

💥 How to start?!

Below you will find the process and workflow used to review and merge your changes.

Step 0 : Find an issue🤔

  • Take a look at the Existing Issues or create your own Issues!
  • Wait for the Issue to be assigned to you after which you can start working on it.
  • Note : Every change in this project should/must have an associated issue.

Step 1 : Fork the Repository🔗

1. Fork this Repository . Click on the symbol at the top right corner. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in upstream remote.

2. Clone the forked repository.

git clone https://github.com/<your-username>/<repo-name>

3. Navigate to the project directory.

cd SFC-foundations

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/<upstream-owner>/<repo-name>

5. Check the remotes for this repository.

git remote -v
  • If you have already forked the project, update your copy before working.
git remote update
git checkout <branch-name>
git rebase upstream/<branch-name>

Step 2 : Branch

6. Create a new branch. Use its name to identify the issue your addressing.

# It will create a new branch with name Branch_Name and switch to that branch 
git checkout -b branch_name

Step 3 : Work on the issue assigned

7. Add all the files/folders needed.

# To add all new files to branch Branch_Name  
git add .  

# To add only a few files to Branch_Name
git add <some files>

Step 4 : Commit your changes .

8. Give a descriptive message for the convenience of reviewer by:

# This message get associated with all files you have changed  
git commit -m "message"
  • NOTE: A PR should have only one commit. Multiple commits should be squashed.

Step 5 : Work Remotely

9. Now you are ready to your work to the remote repository.

  • When your work is ready and complies with the project conventions, upload your changes to your fork:
# To push your work to your remote repository
git push -u origin Branch_Name

Step 6 : Pull Request

  • Go to your forked repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.
  • Create a Pull Request which will be reviewed and suggestions would be added to improve it.
  • Add Screenshots to help us know what this enhancement/implementation is all about. Your Pull Request has been submitted and will be reviewed by the maintainer and merged.

10. Congratulations!✨✨ Sit and relax, you've made your contribution to SFC-foundations project.😎

Things to remember while contributing:

  • Please make sure to update tests case wherever necessary.
  • If any package is used that was not present in the requirements.txt, add the package name and the version used to the requirements.txt file.

For major changes, you are welcomed to open an issue and discuss what you would like to contribute. Enhancements will be appreciated.

built with love Open Source Love svg2