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.
Please note we have a code of conduct please follow it in all your interactions with the project.
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
- Cloning a Repo
- How to create a Pull Request
- Getting started with Git and GitHub
- Learn GitHub from Scratch
- Go to the project's issues.
- Give proper description for the issues.
- Don't spam to get the assignment of the issue 😀.
- Wait for till someone is looking into it !.
- Start working on issue only after you got assigned that issue 🚀.
# Steps For Contribution⚡
-
Star ⭐
-
Fork
-
Clone the forked repository.
git clone https://github.com/<your-github-username>/NEWS-AGGREGATOR-PROJECT.git- Navigate to the project directory.
cd NEWS-AGGREGATOR-PROJECT- Install virtualenv library
pip install virtualenv- Create virtual environment
virtualenv venv- Activate virtual environment
- For Windows:
venv\Scripts\activate- For Unix/Linux/MacOS:
source venv/bin/activate- Install required dependencies
pip install -r requirements.txt- Create a new branch.
git checkout -b <your_branch_name>-
Make changes.
-
Stage your changes and commit
git add -A
git commit -m "<your_commit_message>"- Push your local commits to the remote repo.
git push -u origin <your_branch_name>- Create a Pull Request.
- Ensure that you have self reviewed your code 😀
- Make sure you have added the proper description for the functionality of the code
- I have commented my code, particularly in hard-to-understand areas.
- Add screenshot it help in review.
- Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀