Skip to content

Latest commit

 

History

History
71 lines (61 loc) · 2.35 KB

contributing.md

File metadata and controls

71 lines (61 loc) · 2.35 KB

Contribution

Get Started

  • Fork the project on GitHub
  • Clone the project
git clone https://github.com/Kashishjain04/covid19-react.git
  • Make/add your changes locally
  • Add and commit your changes
git add .
git commit -m "some changes"
  • Make a new branch
git checkout -b "branch name"
  • Push to your forked repository
git push
  • Compare, look for conflicts and make your pull request

We will actively look for any pending pull request(s)

Issues

Issues are valuable

  • Check for existing issues or create a new one with all the changes you want to make
  • Make sure you ask the maintainers to assign you an issue if you want to work on it
  • Point out any errors or any improvements which could be made
  • Pour in your ideas, they are source for contributions others can make
  • Be humble and request for any clarification needed
  • Its for the community, learn and help others
  • Before making any PR, make sure you're establishing a new issue or requesting for a specific problem to be assigned to you. Thank you for creating issues!

Pull requests

They are the best way of getting your creative ideas into the project.

  • Make sure all your pull requests are directed to master branch.
  • Please mention the issue number in your PR so that it's easier for the maintainers to track it
  • Do not create spam pull requests, you will be reported

Before making a pull request ask yourself these

Do I have an authentic intention

You should be clear which problem you're trying to solve with your contribution.
Issue the problem you discovered, and the pull request shows the action you took to address it.
Always comment and clarify your intention

Does the contribution brings the project closer to its goal

The aim of the repository is:

  • To improve and add features to the project to enhance usability and increase scalability.
  • To keep the basic concept of keeping track of daily budget and building smart solutions.
  • To provide the community with a basic html-js app template.
  • To improve the overall UI and user experience.

Does it follow the code of conduct

  1. Using a consistent coding style with the project
  2. Keeping the interest of FOSS
  3. Using welcoming and inclusive language
  4. Being respectful of differing viewpoints and experiences
  5. Focusing on what is best for the community