Skip to content

Latest commit

 

History

History
81 lines (51 loc) · 3.01 KB

contributing.md

File metadata and controls

81 lines (51 loc) · 3.01 KB
Raw

💥 How to Contribute

  • 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 openprivacytech 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>/openprivacytech
  1. Navigate to the newly created openprivacytech project directory:
cd openprivacytech
  1. Set upstream command:
git remote add upstream https://github.com/openprivacytech/openprivacytech.org.git
  1. Create a new branch:
git checkout -b YourBranchName
  1. 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

  1. Make your changes to the source code.

  2. Stage your changes and commit:

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

git commit -m"<Your Change>"
  1. Push your local commits to the remote repository:
git push origin YourBranchName

  1. Create a Pull Request!

  2. Congratulations! You've made your first contribution to openprivacytech!

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

💥 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.