Skip to content

Latest commit

 

History

History
81 lines (52 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

81 lines (52 loc) · 2.92 KB
Raw

⚡ How to Contribute

  • Take a look at the existing Issues or create a new issue!
  • Fork the Repo, create a branch for any issue that you are working on and 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 that are included in your commits.

↗️ HOW TO MAKE A PULL REQUEST:

1. Start by making a fork the ekatraone-backend repository. Click on the symbol at the top right corner.

2. Clone your new fork of the repository:

git clone https://github.com/<your-github-username>/ekatraone-backend

3. Set upstream command:

git remote add upstream https://github.com/vruksheco/ekatraone-backend.git

4. Navigate to the new project directory:

cd ekatraone-backend

5. Create a new branch:

git checkout -b YourBranchName

6. Sync your fork or 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:

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 contribution to ekatraone-backend! 🙌🏼

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

💥 Issues

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

All the best! 🥇