🚀 Start your Open Source Journey! Contribute Today! 🤝
- What is GitOpener?
- Learn Contributing 📖
- Become Contributor 👥
- How it works 🛠️
- How to create your profile 📝
- Contribution guide 🤝
- 📝 License
Git Opener is a beginner friendly open source project. This project serves as a guide to open source, with step by step information on how you can contribute. If you want to see your code in action, you're in the right place! 💻
Everything you need to know to contribute to open source can be found here, from creating an issue to opening a pull request. Basic terminology can be found here! 📚
Contributors are featured on the web app. 👨💻👩💻
Based on your contribution file your-github-username.mdx, GitOpener will authenticate you.
Installation steps are featured here.
If you want to skip the installation and create your profile directly, head over to docs.
Check out the contribution guidelines before contributing.
This is a Next.js project bootstrapped with create-next-app
- Fork the repo into your account 🍴
- Clone the project into your local machine 🖥️
git clone https://github.com/<Your-GitHub-username>/gitopener.vercel.app.git- Navigate the folder 📂
cd gitopener.vercel.app- Install the dependencies 📦
As Git Opener uses yarn package manager, it is recommended to use yarn, install yarn
yarn install- Make .env.local file in root directory with these variables 📁
This step is optional, Do this step if you want to run complete application with database support
MONGO_URI= 'YOUR MONGODB CONNECTION STRING GOES HERE'
GITHUB_TOKEN= 'YOUR GITHUB TOKEN GOES HERE'
- Get mongodb connection string here: MONGODB DOCS
- Generate github token here: GITHUB TOKEN
- Run the project on local machine
yarn dev- Every time you start making changes to your forked repo make sure it's in sync with the original repo
Thank you for considering to contribute to this project.
This project is in a very early stage so anybody who's familiar with ReactJS/NextJS/Typescript/TailwindCSS can contribute. If you don't feel ready to make a contribution yet, no problem at all. You can also contribute to this README section or the Documentation part of our project. 😊
If you are interested to contribute and want to learn more about the technologies that are used in this project, checkout the links below. 🔍
Never made an open source contribution before? And wondering how to contribute to this project? 😕 No worries! Here's a quick guide, 🚀
- Choose any feature/bug you wish to contribute to. 🎉
- Fork the repository into your own account. 🍴
- Clone the repo you have forked in your local machine using
git clone https://github.com/<Your-GitHub-username>/gitopener.vercel.app.git - Create a new branch for your fix by using the command
git checkout -b YourName-branch-name - Make the changes you wish to do and stage them using the command
git add files-you-have-changedor usegit add . - Use the command
git commit -m "Short description of the changes"to describe the changes you have done with a message. - Push the changes to your remote repository using
git push origin your-branch-name - Submit a PR(pull request) to the upstream repository
pbclife/gitopener.vercel.appwith a title and a small description. 🙏 - Wait for the pull request to be reviewed by us. 🕰️
- Make appropriate changes if the maintainer recommends you to and submit it. 🔄
- Await for your contribution to be merged into the repository. 🎊
Checkout the Contributing.md file before contributing. 📖
View Project License
This project is licensed under the terms of the MIT license. The MIT license is a permissive free software license that allows you to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software. It is a simple and short license that is compatible with most open source licenses and is widely used in the open source community.
The MIT license includes a disclaimer of liability, meaning that the project's contributors cannot be held liable for any damages that may arise from the use of the software. It also requires that any copies or modifications of the software include the same license terms and copyright notice as the original software.
Give a ⭐ to the project if you liked it. 😊