Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

contribute to documentation #44

Open
gasparmi opened this issue Jun 4, 2020 · 2 comments
Open

contribute to documentation #44

gasparmi opened this issue Jun 4, 2020 · 2 comments

Comments

@gasparmi
Copy link

gasparmi commented Jun 4, 2020

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

@ayastreb
Copy link
Owner

ayastreb commented Jun 5, 2020

Hi Miguel,

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

@gasparmi
Copy link
Author

gasparmi commented Jun 5, 2020

Hi Anatoliy,

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

Miguel Gaspar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants