CONTRIBUTING 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. ============
  2. Contributing
  3. ============
  4. For more information, please see the official contribution docs at
  5. http://mico.ajdiaz.me/en/latest/contributing.html.
  6. Contributing Code
  7. =================
  8. * A good patch:
  9. * is clear.
  10. * works across all supported versions of Python.
  11. * follows the existing style of the code base (PEP-8).
  12. * has comments included as needed.
  13. * A test case that demonstrates the previous flaw that now passes
  14. with the included patch.
  15. * If it adds/changes a public API, it must also include documentation
  16. for those changes.
  17. * Must be appropriately licensed (GPLv2 or newer version).
  18. Reporting An Issue/Feature
  19. ==========================
  20. * Check to see if there's an existing issue/pull request for the
  21. bug/feature. All issues are at https://github.com/ajdiaz/mico/issues
  22. and pull reqs are at https://github.com/ajdiaz/mico/pulls.
  23. * If there isn't an existing issue there, please file an issue. The ideal
  24. report includes:
  25. * A description of the problem/suggestion.
  26. * How to recreate the bug.
  27. * If relevant, including the versions of your:
  28. * Python interpreter
  29. * mico
  30. * Optionally of the other dependencies involved
  31. * If possile, create a pull request with a (failing) test case demonstrating
  32. what's wrong. This makes the process for fixing bugs quicker & gets issues
  33. resolved sooner.
  34. What we need?
  35. =============
  36. * To improve mico we need a lot of *new libraries*, core libraries is our main
  37. focus right now, for next versions of mic we like to have a lot of core
  38. libs, such like change parameters in the OS, modify some base system
  39. config, or more high level ones like "Install a full LAMP architecture".
  40. Every new library is welcome.
  41. * We need more pre-defined templates, like "ls" does. For example a cost
  42. template to calculate EC2 budget.
  43. * More EC2 libraries, for example for S3.
  44. * Fix bugs... we need to remove the Beta tag ;)