Skip to content

Commit 0cda2ab

Browse files
authored
added CONTRIBUTING.md ⭐ (#331)
* added CONTRIBUTING.md * updated README
1 parent 584ee08 commit 0cda2ab

File tree

2 files changed

+69
-9
lines changed

2 files changed

+69
-9
lines changed

CONTRIBUTING.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# 🚀 Contributing to the MasterPortfolio Project
2+
3+
Thank you for considering contributing to the MasterPortfolio project! Your help is greatly appreciated. 😊
4+
5+
## 🤝 How to Contribute
6+
7+
Here are some fun and precise steps to get you started:
8+
9+
1. **Fork the Repository** 🍴
10+
- Click the "Fork" button on the top right of the [MasterPortfolio repository](https://github.com/ashutosh1919/masterPortfolio) page on GitHub. This will create a copy of the project in your own GitHub account.
11+
12+
2. **Clone Your Fork** 🧙‍♂️
13+
- In your terminal, run the following command to clone your fork to your local machine:
14+
```
15+
git clone https://github.com/YourUsername/masterPortfolio.git
16+
```
17+
18+
3. **Switch to the Project Directory** 📁
19+
- Move into the project directory using:
20+
```
21+
cd masterPortfolio
22+
```
23+
24+
4. **Move to Gatsby** 🚀
25+
- If you're working on this task, please help us migrate the project to Gatsby. Make the necessary changes and test everything to ensure it works smoothly.
26+
27+
5. **Add Podcast and Video Sections** 🎙️📹
28+
- We'd love to have sections for podcasts and videos on the portfolio. Create these sections and make sure they look fantastic.
29+
30+
6. **Add Tests for Automation** 🧪
31+
- To ensure code quality, add tests where appropriate. Use test frameworks like Jest or Cypress, and make sure the tests pass.
32+
33+
7. **Set Up Travis Workflow** 🤖
34+
- Implement a Travis CI workflow to automate builds and testing. This will help ensure that changes don't break the project.
35+
36+
8. **Create a Branch** 🌿
37+
- Create a new branch for your changes with a descriptive name. For example:
38+
```
39+
git checkout -b gatsby-migration
40+
```
41+
42+
9. **Make Your Changes** 💡
43+
- Implement your awesome changes and features.
44+
45+
10. **Commit Your Changes** 📝
46+
- Commit your changes with a descriptive message. For example:
47+
```
48+
git commit -m "Added Gatsby migration and podcast section"
49+
```
50+
51+
11. **Push Your Changes** 🚢
52+
- Push your changes to your fork on GitHub:
53+
```
54+
git push origin gatsby-migration
55+
```
56+
57+
12. **Create a Pull Request** 🙌
58+
- Go to your fork on GitHub, and click the "New Pull Request" button. Follow the prompts, and submit your changes for review.
59+
60+
13. **Celebrate** 🎉
61+
- You've contributed to the MasterPortfolio project! Thanks for your hard work and dedication.
62+
63+
## 📌 Issues
64+
65+
If you encounter any issues or have ideas for improvements, please open an [issue](https://github.com/ashutosh1919/masterPortfolio/issues) and let us know.
66+
67+
## 🙏 Thank You
68+
69+
We appreciate your contribution and look forward to working together to make the MasterPortfolio project even better! 😄🚀

README.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -207,15 +207,6 @@ If you are stuck somewhere and want to observe the deployment process in depth,
207207
208208
This project is licensed under the MIT License - see the [LICENSE.md](./LICENSE) file for details.
209209
210-
# Contributing 💡
211-
212-
If you can help us with these. Please don't hesitate to open an [pull request](https://github.com/ashutosh1919/masterPortfolio/pulls) or [issue](https://github.com/ashutosh1919/masterPortfolio/issues).
213-
214-
- Move to Gatsby
215-
- Add Podcast Section and Video Section
216-
- Add tests to automate review.
217-
- Setup Travis workflow.
218-
219210
# Contributors ✨
220211
221212
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

0 commit comments

Comments
 (0)