Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 1.44 KB
Raw

Contributing

If you want to contribute to this repository, please first mail the owner of this repository for the changes you want to make. Please follow the code of conduct which we have attached in our repository. Also strictly follow our table of contents and make the required changes accordingly.

Pull Request Process

  1. Pass all the test cases that we have mentioned in the test.py.
  2. Update the README.md with the changes you have made.
  3. Add all the unnecessary build files have to the .gitignore file.
  4. Mention any new installatiuon dependencies in the requirements.txt file.

Committing Changes

  1. You need to start an issue on the project kanban board.
  2. You need to move this issue from to_do to in progress.
  3. Create a new branch and clone the repository.
  4. Change the branch of the code using git checkout.
  5. Make the required changes and commit everything to the newly created branch.
  6. Create a new pull request.

Our Table Of Contents

  • .github workflows all github workflow yaml files

  • docs proj1rubrics.md

  • .gitignore

  • .travis.yml

  • CITATION.md

  • CODE_OF_CONDUCT.md

  • CONTRIBUTING.md

  • LICENSE

  • README.md

  • requirements.txt

  • setup.py

  • code init.py

  • data README.md

  • test README.md test.py

Attribution

Code of Conduct was adapted from [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.