Skip to content

Latest commit

 

History

History
102 lines (68 loc) · 3.81 KB

CONTRIBUTING.md

File metadata and controls

102 lines (68 loc) · 3.81 KB
Raw

✨ FinNews - Contributors Guide ✨


We thank you for your interest in contributing.😊
This guide will help you get started with the project and make your first contribution.


What to Contribute?

🐞Bug Fixes: Contributors can help by reviewing and confirming reported issues. This includes verifying bugs, providing additional details, and prioritizing tasks for the development team.

✨Feature Implementation : Contributors can enhance the project by implementing new features or improvements suggested by users. This involves understanding requirements, designing solutions, and extending the functionality. 🚀

Steps to Contribute

  • Drop a Star ⭐ in this repo
  • Take a look at the existing Issues.
  • Fork the Repo & create a branch for any issue that you are working on and commit your work.
  • At first raise an issue in which you want to work
  • Then after assigning only then work on that issue & make a PR
  • Create a Pull Request, which will be promptly reviewed and given suggestions for improvements by the community.
  • REMINDER: Please don't raise more than 2 Issue at a time
  • IMPORTANT: Please don't make any type of Pull Request until & unless you get assigned to an Issue
  • Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes that are included in your commits.

Submit a Pull Request?

1. Start by forking the FinNews repository. Click on the symbol at the top right corner.

2. Clone your forked repository:

git clone https://github.com/Your-Username/FinNews.git

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

git remote add upstream https://github.com/divyansh-2005/FinNews

4. Check the remotes for this repository.

git remote -v

5. 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

6. Create a Branch: Create a new branch for your changes:

git checkout -b my-feature

7. Make Changes: Make your desired changes to the codebase.

git add .
git add <filename>

8. Commit Changes: Commit your changes with a descriptive commit message:

git commit -m "Add new feature"

9. Push Changes: Push your changes to your forked repository:

git push origin my-feature

10. Submit a Pull Request: Go to your forked repository on GitHub and submit a pull request. Be sure to provide a detailed description of your changes and why they are necessary.

11. Congratulations! You've made your first contribution! 🙌🏼

⚡ Pull Requests Review Criteria 🧲

  1. Please fill the PR Template properly while making a Pull Request.
  2. Never commit in the main branch.
  3. Your work must be original, written by you not copied from other resources.

Documentation 📑

  • Document any significant changes or additions to the codebase.
  • Provide clear and concise explanations of the functionality, usage, and any relevant considerations.
  • Update the README.md file to reflect the changes made and provide instructions on how to use the project (if needed).

⚡ Acknowledgements 📄

Thank you for considering contributing to FinNews! If you enjoy working with us, please give the project a ⭐ star! Your support means a lot and encourages further contributions.

Congratulations on successfully submitting your PR to our project! 🎉

Happy coding! 🚀