CONTIBUTING.md

Contributing to Project Showcase

First off, thank you for taking your time to contribute to this project! 🎉

Getting Started

To set up the project on your local system, follow the below guidelines:

1. Fork this repository.

2. Clone your forked copy of the project.

git clone https://github.com/<your_user_name>/Projects-showcase.git

3. Navigate to the project directory 📁

cd Projects-showcase

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/Design-and-Code/Projects-showcase.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).

git pull upstream main

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perfom your desired changes to the code base.

9. Track your changes ✔

git add . 

10. Commit your changes.

git commit -m "Relevant message"

11. Push the committed changes in your feature branch to your remote repository.

git push -u origin <your_branch_name>

12. To create a pull request, click on the big green New pull request button.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create Pull Request.

15 Voila! You have made a PR to the Projects-showcase 💥 Wait for your submission to be accepted and your PR to be merged.

Want to add your project to the repository?

You can contribute by adding your Projects under the public --> Projects. Create a directory by your name here. Add your individual projects to this folder.

root
└──  public
|      └──Projects
|          ├── Your Name
|          │    ├── Project Name
|          │    │     └── Code files
|          |    │     └── deployedLink.txt
|          |    |     └── thumbnail.png
|          |    |
|          │    │
|          │    └── Project Name
|          │          └── Code files
|          |          └── deployedLink.txt
|          |          └── thumbnail.png

Don't forget to add a deployedLink.txt file in each project folder, which should contain the link where your project is deployed. Also add a screenshot of your project as thumbnail.png file.

• Use PascalCase or Snake-Case naming convention for project folders.

Want to request enhancements to the project?

Sure! Feel free to create a descriptive issue here stating your suggestions, how you plan to contribute and possible screenshots (as example, if applicable). Please be patient till the issue is assigned to you by the maintainers. ✨

Have more questions?

You can head over to our community on Discord to ask questions that are not answered here.