Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 1.42 KB
Raw

Contribution

Thank you for contributing to us 🎉 .

Contributing Guidelines

###Basic contributing Guidelines

  1. If you see an issue already created, that you think you can resolve, comment on it and ask the maintainers to assign it to you. We will be more than glad to do so :)
  2. Commit message should be of the stated syntax. Use only absolute verbs like Create, Update, etc and no past or future tenses like creating/created.
  3. Add comments to codes. This increases readability. However do not raise issues or PRs only to add comments.
  4. When naming the functions or variables use meaningful names instead of just random ones. Preferrably, refer to similar files or functions to get an idea.
  5. Every PR would be reviewed before it gets approved to merge.

Ways in which you can contribute

  1. Improve UI -> Level 1
  2. Set size of opening window -> Level 1
  3. Add a config file and environment variables -> Level 2
  4. Create a new pipenv -> Level 2
  5. Make a batch script so that the program runs easier on windows -> Level 2
  6. Make the startup faster (for this see the next sub-heading) - Level 3

Overhauling the whole code

This work is a long going process. I want to completely overhaul the program in C so that it startsup faster. Please suggest any other ideas to make it run faster. This is a LEVEL 3 task, and anyone who wants to work on it must contact the repo owner - TathagataRoy1278