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

DOC: Add markdown file on contributing to gdeltPyR #29

Open
linwoodc3 opened this issue Jul 18, 2017 · 1 comment
Open

DOC: Add markdown file on contributing to gdeltPyR #29

linwoodc3 opened this issue Jul 18, 2017 · 1 comment

Comments

@linwoodc3
Copy link
Owner

linwoodc3 commented Jul 18, 2017

  • Use the pandas contributing document as a guide.
  • Define versioning logic
  • Implement release plans with group of features to add before version number updated
  • Explain how to set up dev environment

Early contributing guidance:

  • I'm using http://semver.org/ and this stack overflow post as a model for versioning; I'm using four schemed number (0.0.0.0):

    • major version (changes when all planned features are added)
    • minor version (changes when new classes or modules are added that change the results or analysis on GDELT data returned)
    • minor-minor version (changes with smaller enhancements like classes or modules that just return unaltered data, new parameters to existing classes/modules, etc.)
    • Bug fixes - Last number is the bug fix count for current build; no changes to existing functionality but fixes a MAJOR bug that stops the entire module for working. Simple little bug fixes don't get counted. Resets to zero on minor-minor change. Only counts bugs so if no bugs...stays at zero. Eventually will drop this number off when the unit test suite has 80% coverage.
  • Small one or two-line entry in CHANGES (gdeltPyR --> CHANGES). Just a date line and description that says something like "added support to translated GDELT data" you can add your github username if you want too.

  • Add short bullet to README.md and README.rst. (gdeltPyR --> README.md (rst)). This just announces the new feature on the first page.

This looks good. Thanks for adding the unittests.

Administrative changes before any merge.

  • Small one or two-line entry in CHANGES explaining what you did (gdeltPyR --> CHANGES). Just a date line and description that says something like "Added support to translated GDELT data" you can add your github username if you want too.

  • Add short bullet to README.md and README.rst. (gdeltPyR --> README.md (rst)). This just announces the new feature on the first page.

  • Add issue that defines what bug or feature you plan to do. Reference the issue in commits and close it if you commit addresses the issue whether it's an enhancement, bug fix, or documentation update, etc.

  • (Optional) ** Add your name or github user name (or combo) to the AUTHORS.rst** (gdeltPyR --> AUTHORS.rst). Keep track of all contributors to show power of open source. Feel free to add your country as well.

@linwoodc3
Copy link
Owner Author

https://pandas.pydata.org/pandas-docs/stable/contributing.html

  • ENH: Enhancement, new functionality
  • BUG: Bug fix
  • DOC: Additions/updates to documentation
  • TST: Additions/updates to tests
  • BLD: Updates to the build process/scripts
  • PERF: Performance improvement
  • CLN: Code cleanup

@linwoodc3 linwoodc3 modified the milestone: Phase 1 Aug 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant