Skip to content

Commit

Permalink
Merge pull request #117 from Sibam-Paul/DocTechLinks
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Sahil1786 authored May 22, 2024
2 parents 8bd2b29 + 75a18c7 commit d9fe345
Show file tree
Hide file tree
Showing 11 changed files with 548 additions and 234 deletions.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# **Contributing Guidelines** 📄

This documentation contains a set of guidelines to help you during the contribution process.
We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project.
Thank you for helping out and remember, **no contribution is too small.**
<br>
Please note we have a [code of conduct](CODE_OF_CONDUCT.md) please follow it in all your interactions with the project.



<br>

## **Need some help regarding the basics?🤔**


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

- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request)
- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
- [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources)

<br>

## **Issue Report Process 📌**

1. Go to the project's issues.
2. Give proper description for the issues.
3. Don't spam to get the assignment of the issue 😀.
4. Wait for till someone is looking into it !.
5. Start working on issue only after you got assigned that issue 🚀.

<br>

## **Pull Request Process 🚀**

1. Ensure that you have self reviewed your code 😀
2. Make sure you have added the proper description for the functionality of the code
3. I have commented my code, particularly in hard-to-understand areas.
4. Add screenshot it help in review.
5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀

<br>

# **Thank you for contributing💗**
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ PETARI, The Food Donate WebApp, is an initiative by an organization aiming to re
## Tech Stack

### Frontend
- HTML
- CSS
- Bootstrap
- JavaScript
- [HTML](https://www.w3schools.com/html/html_intro.asp)
- [CSS](https://www.w3schools.com/cssref/index.php)
- [Bootstrap](https://getbootstrap.com/)
- [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)

### Backend
- Node.js
- EJS
- Express.js
- MongoDB
- Authentication (Auth 2.0)
- [Node.js](https://nodejs.org/docs/latest/api/)
- [EJS](https://www.npmjs.com/package/ejs)
- [Express.js](https://expressjs.com/)
- [MongoDB](https://www.npmjs.com/package/mongodb)
- [Authentication (Auth 2.0)](https://oauth.net/2/)

# Contribution Guidelines

Expand Down
Loading

0 comments on commit d9fe345

Please sign in to comment.