Skip to content

DOC: creating CONTRIBUTING.md from contributing.rst #12375

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

Closed
jreback opened this issue Feb 18, 2016 · 6 comments
Closed

DOC: creating CONTRIBUTING.md from contributing.rst #12375

jreback opened this issue Feb 18, 2016 · 6 comments
Labels

Comments

@jreback
Copy link
Contributor

jreback commented Feb 18, 2016

Pandas Issue Submission Template

This template will help you and us respond to your issues in an efficient and timely manner.
Please fill out all sections and use github markdown for code blocks

Actual Behavior

Expected Behavior

output of pd.show_versions()

so this is what the new ISSUE_TEMPLATE looks like its in .github/ISSUE_TEMPLATE.md. Furthermore, now the CONTRIBUTING.md shows up when you create a new issue.

@jreback jreback added the Compat pandas objects compatability with Numpy or Python functions label Feb 18, 2016
@jreback
Copy link
Contributor Author

jreback commented Feb 18, 2016

of course stylistic changes are welcome :)

there is a PULL_REQUEST.md template we can add as well.

@jreback
Copy link
Contributor Author

jreback commented Feb 18, 2016

I think the CONTRIBUTING.md should simply be: http://pandas.pydata.org/pandas-docs/stable/contributing.html but would have to do this as part of the doc-building process? (e.g. convert the .rst to .md)?

@jorisvandenbossche @TomAugspurger ?

@jreback jreback added the Docs label Feb 18, 2016
@TomAugspurger
Copy link
Contributor

I don't think we need the sentence with "This template will help you...", people will get used to these. Best to keep the boilerplate to a minimum. Could probably scrap the "Please fill out" as well.

Maybe instead of "Actual Behavior" we have "Code Example" or something that really drives home the point that we want a copy-pastable example possible.

Something like:


Code Sample

# A copy-pastable example if possible:

Expected Output

Versions

Output of pd.show_versions()


The pull request template could have check boxes for

  • Closes #xxxx
  • git diff upstream/master | flake8 --diff
  • whatsnew entry

@jreback
Copy link
Contributor Author

jreback commented Feb 18, 2016

ok updated. feel free to mod

@jreback jreback changed the title CONTRIB: ISSUE_TEMPLATE / CONTRIBUTING DOC: creating CONTRIBUTING.md from contributing.rst Feb 18, 2016
@jreback
Copy link
Contributor Author

jreback commented Feb 18, 2016

I have changed this to be a doc generation step to make CONTRIBUTING.md from contributing.rst. This would have to be an external step we only do when we make changes to contributing.rst.

@jreback jreback added this to the 0.18.1 milestone Feb 18, 2016
@jreback jreback modified the milestones: 0.18.2, 0.18.1 Apr 18, 2016
@jorisvandenbossche jorisvandenbossche modified the milestones: 0.20.0, 0.19.0 Aug 15, 2016
@jorisvandenbossche jorisvandenbossche removed Community Compat pandas objects compatability with Numpy or Python functions labels Feb 17, 2017
@jorisvandenbossche
Copy link
Member

Closing this in favor of #15349

@jorisvandenbossche jorisvandenbossche modified the milestones: No action, 0.20.0 Feb 17, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants