Skip to content

Add CONTRIBUTING.md file #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bodhisha merged 6 commits into from
Apr 17, 2021
Merged

Add CONTRIBUTING.md file #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b82edd6
Create CONTRIBUTING.md
ShrillShrestha Apr 15, 2021
bb4f75a
Update CONTRIBUTING.md
ShrillShrestha Apr 15, 2021
d6e3848
Update CONTRIBUTING.md
ShrillShrestha Apr 16, 2021
a1399b3
Merge pull request #1 from MLH-Fellowship/main
ShrillShrestha Apr 16, 2021
c4c3c22
Update CONTRIBUTING.md
ShrillShrestha Apr 16, 2021
1356952
Update README.md
ShrillShrestha Apr 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Contribution Guidelines:

SocioMark is a social media platform that lets you upload images and secures them by embedding a personalised hash.

## Contribution Steps:

- If you want to work on an existing issue to make a contribution head to the [issue section](https://github.com/MLH-Fellowship/SocioMark/issues) for the project.
If you are working on a pre-existing issue, let us know by assigning it to yourself or let us know in the comment.
- You can also submit a issue to work on. The issue can be realted to any topic from bug, refactoring, UI changes, etc.
- If you have any question regarding the issues, feel free to ask in the issue's comment section.

- ### In order to start working on the issue:
- Create a fork of the project.
- Clone the repo locally with `git clone https://github.com/<YOUR_USERNAME>/SocioMark.git`
- Checkout in a new branch with `git checkout -b <YOUR_BRANCH_NAME>`
- Make the required changes
- Add and commit your changes with `git add <changes>` and `git commit -m "your commit message"`
- Then push the changes into your branch `git push origin branch_name`
- Before making a PR, make sure your copy of the project is up-to-date with the main project.
- If forked project is up-to-date with the main project, go ahead and make the PR.
- #### If there has been any commit since you forked the project, there might be some conflicts while making the PR. In case of any conflicts:
- Set an upstream with `git remote add upstream https://github.com/MLH-Fellowship/SocioMark.git`
- Checkout to main branch and `git pull upstream main`
- Checkout to the branch you were working on
- Rebase it with the main branch with `git rebase main`
- If there are any conflicts while rebasing, resolve them locally, and continue the rebase with `git rebase --continue`
- Test it locally
- If everything is working as expected, push it to the origin
- Make a PR to the main project
- Once the PR is made, someone from our team will review it and approve/request changes accordingly.
8 changes: 1 addition & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,7 @@ Being a fully responsive and compatible application, it provides users with the
- Navigate to ```http://localhost:3000/```

## 🚩 How to Contribute
- Fork and clone the repository ```git clone https://github.com/MLH-Fellowship/SocioMark.git```
- Create a branch ```git checkout -b "branch_name"```
- Make changes in that branch
- Add and commit your changes with ```git add <changes>``` and ```git commit -m "your commit message"```
- Then push the changes into your branch ```git push origin branch_name```
- Now you can create a PR using that branch in our repository.
- 🎉 You have successfully contributed to this project.
- You can check out the [CONTRIBUTING.md](https://github.com/MLH-Fellowship/SocioMark/blob/main/CONTRIBUTING.md) file in the repo 😄.

## 🤓 Future Improvements
- Follower functionality that improves interaction between users and lets users customize their feed pages
Expand Down