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

Add FAQ entry about requesting new Trove classifiers #3410

Merged
merged 7 commits into from
Mar 31, 2018

Conversation

theacodes
Copy link
Contributor

Fixes #3028

@nlhkabu nlhkabu requested a review from brainwane March 26, 2018 05:59
@nlhkabu
Copy link
Contributor

nlhkabu commented Mar 26, 2018

ping @brainwane on this. Maybe we should also add a new github issue template for this?

Copy link
Contributor

@brainwane brainwane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we be more specific about what we need from the requester?

@theacodes
Copy link
Contributor Author

Can we be more specific about what we need from the requester?

Sure - beyond the name of the classifier is there any other info we need?

@dstufft
Copy link
Member

dstufft commented Mar 26, 2018 via email

@theacodes
Copy link
Contributor Author

More details added in 39a99e8

@brainwane
Copy link
Contributor

Maybe we should also add a new github issue template for this?

This sounds like a good idea! "Adding a trove classifier? (a) name of new classifier (b) why don't the existing classifiers fit this need?"

<p>
If you would like to request a new Trove classifer please file a bug on our <a href="https://github.com/pypa/warehouse/issues" target="_blank" rel="noopener">issue tracker</a>. Please include the name of the requested classifier and a brief justification of why it is important.
</p>

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the {% macro code_of_conduct() %} block here as it is in other similar answers that are primarily about filing an issue. Thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in d230e29

@theacodes
Copy link
Contributor Author

Okay, I think this is about ready to merge.

Screenshot:

screen shot 2018-03-27 at 2 04 54 pm

@nlhkabu
Copy link
Contributor

nlhkabu commented Mar 28, 2018

Thanks @jonparrott !

Following from my previous comment - could you please add a new GitHub template (see https://github.com/pypa/warehouse/blob/master/.github/ISSUE_TEMPLATE/visual-design.md as an example).

It should be named 'request-trove-classifier.md' and include something like:

## The name of the classifier you would like to add
<-- Classifier name -->

## Why do you want to add this classifier?
<!-- Please include a brief explanation to justify your request. Why do the current classifiers not meet your need? -->

Then we can change the link to the issue tracker to use this GitHub template. It would also be cool if we could apply the 'classifier request' badge. The docs for how to do this are here: https://help.github.com/articles/about-automation-for-issues-and-pull-requests-with-query-parameters/

Let me know if anything is unclear, or you need help :)

@nlhkabu nlhkabu self-requested a review March 28, 2018 18:10
@theacodes
Copy link
Contributor Author

@nlhkabu great idea. Done in 8ee6c86

It would also be cool if we could apply the 'classifier request' badge.

Turns out GitHub doesn't allow non-project members to set labels, so I couldn't make this happen.

<!--
Please include a brief explanation to justify your request.
Why do the current classifiers not meet your need?
How many packages to you expect to use this new classifier?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, I'm a little unclear -- do you mean how many different PyPI projects? I figure usually that's what we want to ask, but I am open to being told differently!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, project is the right terminology. You would think that I would be better about this. :)

Fixed in ba7560f

@@ -246,6 +248,12 @@ <h3 id="file-name-reuse">{{ file_name_reuse() }}</h3>
To avoid this situation, <a href="https://packaging.python.org/guides/using-testpypi/">use Test PyPI to perform and check your upload first</a>, before uploading to <a href="https://pypi.org">pypi.org</a>.
</p>

<h3 id="new-classifier">{{ new_classifier() }}</h3>
<p>
If you would like to request a new Trove classifier please file a bug on our <a href="https://github.com/pypa/warehouse/issues/new?template=new-trove-classifier.md" target="_blank" rel="noopener">issue tracker</a>. Please include the name of the requested classifier and a brief justification of why it is important.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this wording -- thanks.

@nlhkabu
Copy link
Contributor

nlhkabu commented Mar 29, 2018

Turns out GitHub doesn't allow non-project members to set labels, so I couldn't make this happen.

:( I'll make a separate PR once this is merged.

@brainwane brainwane merged commit 928cd5b into pypi:master Mar 31, 2018
nitinprakash96 pushed a commit to nitinprakash96/warehouse that referenced this pull request Mar 31, 2018
* Add FAQ entry about requesting new Trove classifiers

* Add issue template
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants