Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

36 lines (23 loc) · 2.76 KB

Contributing to 'humble' Open Source Project

humble welcomes contributions. When contributing please follow the Code of Conduct, especially the last section (Update 2022/03/26) on the war in Ukraine and the limitations imposed on this tool: is a personal decision that I hope you understand. Otherwise, and if you don't want to contribute to this project because you don't agree with my decision, I will deeply respect it.

Enhancement & Issues

Feel free to submit bugs, feature requests, security vulnerabilities and your suggestions (to [email protected]).

Contributing

  • Please note (before sending a Pull Request) that humble is a multi-language tool (for now only English and Spanish are supported): take a look at these files, those ending in '_es.txt' are the Spanish translations. Therefore, each Pull Request that adds or modifies text strings must take into account both languages and update the corresponding files; also take a look at the functions get_detail, get_l10n_content, print_detail, print_details, print_detail_l and print_detail_r; they will help you understand how I handle literals and phrases.

  • In case of contributing functions these must be brief and optimized: my personal criteria is that every function must have, at least, a 60% Quality Score in the Sourcery plugin or other similar.

  • And finally, I have my quirks :), and I may not accept your Pull Request for certain reasons that I will always explain in the request itself. That, of course, doesn't mean that I don't value your interest, your time or your code: always, if I end up implementing your idea, I will mention you in the Acknowledgements section.

Thank you for your time!.

Methodology

  1. Read the previous section! :)
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull request so that I can review your changes

Copyright and Licensing

'humble' is licensed under the MIT license.