pycountry icon indicating copy to clipboard operation
pycountry copied to clipboard

Documentation

Open nschimmoller opened this issue 1 year ago • 3 comments

  • Update readme.rst
    • Add Overview
    • Add Table of Contents
    • Add Contributions section
    • Add Installation section
    • Add Requirements section
    • Move code examples to Documentation section
    • Add Contributing section (links to CONTRIBUTING.md)
    • Add License section (links to LICENSE.txt and COPYRIGHT.txt)
    • Add Credits section
    • Add Acknowledgements section
    • Add Maintainers section
  • Create CODEOFCONDUCT.md
    • based upon Contributor Covenant version 2.0
  • Create CONTRIBUTING.md with guide for contributing
  • Create COPYRIGHT.txt
    • Solves #99
  • Create PULL_REQUEST_TEMPLATE.md
  • Created ISSUE_TEMPLATES
    • Includes: BUG_REPORT, DOCUMENTATION_REQUEST, ENHANCEMENT_REQUEST and QUESTION templates.
    • Includes directions on how to report vulnerabilities in non public manner
  • Add SECURITY.md

This change is Reviewable

nschimmoller avatar Dec 20 '23 15:12 nschimmoller

@zware okay breaking #183 into a smaller PRs and rebasing to make commit list less crazy. Mind taking a look?

nschimmoller avatar Dec 20 '23 15:12 nschimmoller

@zware happy new year! wanted to see if you'd have some time soon to review some of the open PRs of mine. Want to avoid making PRs without your or Christian's review in the future.

nschimmoller avatar Jan 04 '24 21:01 nschimmoller

So sorry I haven't made it back here yet, unclaimed time at my desk has not existed lately. Will review as soon as I have a chance.

zware avatar Jan 05 '24 05:01 zware