-
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #24 from Dun-sin/add-contributing-file
docs: add contributing file
- Loading branch information
Showing
1 changed file
with
81 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
## 💥 How to Contribute | ||
|
||
- Take a look at the existing [Issues](https://github.com/openprivacytech/openprivacytech.org/issues) or [create a new issue](https://github.com/openprivacytech/openprivacytech.org/issues/new/choose)! | ||
- [Fork the Repo](https://github.com/openprivacytech/openprivacytech.org/fork). Then, create a branch for any issue that you are working on. Finally, commit your work. | ||
- Create a [Pull Request](https://github.com/openprivacytech/openprivacytech.org/compare) (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](https://github.com/openprivacytech/openprivacytech.org) repository. Click on the <a href="https://github.com/openprivacytech/openprivacytech.org/fork"><img src="https://i.imgur.com/G4z1kEe.png" height="21" width="21"></a>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: | ||
|
||
```bash | ||
git clone https://github.com/<your-github-username>/openprivacytech | ||
``` | ||
|
||
3. Navigate to the newly created openprivacytech project directory: | ||
|
||
```bash | ||
cd openprivacytech | ||
``` | ||
|
||
4. Set upstream command: | ||
|
||
```bash | ||
git remote add upstream https://github.com/openprivacytech/openprivacytech.org.git | ||
``` | ||
|
||
5. Create a new branch: | ||
|
||
```bash | ||
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: | ||
|
||
```bash | ||
git fetch upstream | ||
``` | ||
|
||
```bash | ||
git merge upstream/main | ||
``` | ||
|
||
### [Github Docs](https://docs.github.com/en/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github) 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 | ||
|
||
```bash | ||
git commit -m"<Your Change>" | ||
``` | ||
|
||
9. Push your local commits to the remote repository: | ||
|
||
```bash | ||
git push origin YourBranchName | ||
``` | ||
|
||
10. Create a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)! | ||
|
||
11. Congratulations! You've made your first contribution to [openprivacytech](https://github.com/openprivacytech/openprivacytech.org/graphs/contributors)! | ||
|
||
🏆 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](https://github.com/openprivacytech/openprivacytech.org/issues/new/choose) about what you would like to contribute. Enhancements are always encouraged and appreciated. |