Skip to content

Add development guide to docs#2760

Merged
nicoddemus merged 1 commit intopytest-dev:masterfrom
nicoddemus:labels
Sep 14, 2017
Merged

Add development guide to docs#2760
nicoddemus merged 1 commit intopytest-dev:masterfrom
nicoddemus:labels

Conversation

@nicoddemus
Copy link
Copy Markdown
Member

I started writing about which types of labels we use on our issues because this just grew organically, and realized that we don't have a development guide so I turned it into that.

It is not exhaustive, but at least it will get the ball rolling for further additions.

also, I propose we do the following:

  • It is clear that labels also have a type/category associated to them. I noticed some projects (like pip and tox) use a prefix, and I suggest we adopt this idea as well. Then the classification is much clearer IMHO.

  • Some labels are duplicated or don't seem to have a clear purpose; I propose to just remove them.

Here is a list of labels and a brief description mentioning their intent.


**Type**
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Like I said, I would like to add the prefix to all labels, so we could have type:bug, status:critical and so on. If nobody opposes that, I will do it and update the document.

Comment thread doc/en/development_guide.rst Outdated

Issues specific to an operating systems.

* ``windows``:
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I propose to add linux and mac to the list.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

all plugin ones should be just like plugin: name

Comment thread doc/en/development_guide.rst Outdated

Useful to classify issues for some definite time. They should be removed after they are no longer relevant.

* ``EP2017 sprint``:
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I propose to remove these labels except for mark-issue given that it is still relevant; we can leave them in the docs for example purposes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we can turn mark-issue into a mark plugin one

Comment thread doc/en/development_guide.rst Outdated

Currently not clear what they are for or if they are useful.

* ``classes``:
Copy link
Copy Markdown
Member Author

@nicoddemus nicoddemus Sep 7, 2017

Choose a reason for hiding this comment

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

I think we can remove these entirely (from this document and from GH).

@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 91.805% when pulling 470519f on nicoddemus:labels into 09349c3 on pytest-dev:master.

@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 91.805% when pulling 20b6526 on nicoddemus:labels into e57cc55 on pytest-dev:master.

@RonnyPfannschmidt
Copy link
Copy Markdown
Member

i accidentally did part of this one while cleaning up yesterday

@nicoddemus
Copy link
Copy Markdown
Member Author

Noticed this by accident hehe. Care to comment here what you would like to see changed here for us to merge it @RonnyPfannschmidt?

@nicoddemus
Copy link
Copy Markdown
Member Author

@RonnyPfannschmidt made the changes you requested. I will update the label names as soon as we merge this.

@nicoddemus nicoddemus merged commit 25d2acb into pytest-dev:master Sep 14, 2017
@nicoddemus nicoddemus deleted the labels branch September 14, 2017 22:20
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.

3 participants