money-tracker icon indicating copy to clipboard operation
money-tracker copied to clipboard

contribute to documentation

Open gasparmi opened this issue 4 years ago • 2 comments

Hello there,

I would like to provide a contributor’s guide/documentation for the Money Tracker. Right now it is a bit challenging for a newcomer to start contributing to the project because there is no instruction/documentation on how to do so.

The sections of the developer documentation that I plan to include are the following: • About the project (an incorporation of what you already have) • License: let potential contributors know right away the project’s license rather than having them go search for it in the files • Installation: prerequisites and instructions about how to install the project locally • Contributing: instructions on what needs to be done to contribute, and do a pull request • Community standards: guidelines on how to create a supporting and welcoming community for all contributors • Communication channel: how to communicate with the project owners or maintainers • Development Tracking: for contributors to know what the current bugs/issues are or how to access these

You can always edit/update this documentation to better fit your standards.

Please let me know what you think, and I'm more than happy to do a PR.

Thank you!

Miguel Gaspar

gasparmi avatar Jun 04 '20 03:06 gasparmi

Hi Miguel,

yes, documentation would be great! Let me know if you need any help, although I might not have much time :(

ayastreb avatar Jun 05 '20 05:06 ayastreb

Hi Anatoliy,

Sounds good. I'll polish what I have right now, and I'll do a PR this weekend. Thank you!

Miguel Gaspar

gasparmi avatar Jun 05 '20 05:06 gasparmi