Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
The following rules should be applied to all items inserted in the “Issues-Section”.
When you file a new issue you should make sure to follow this work flow:
“You” means anybody, it can be a developer or just a user who doesn't know anything about programming. “We” means developers who participate in this project or me (the repository owner).
If you …:
- … have a question and don't know how something should work or if it works correctly, create a new issue and give it the label “question” (yellow)
- … see a bug, where something doesn't work as it is supposed to, create a new issue and give it the label “bug” (red)
- … want to have a new feature or function implemented in xodx, create a new issue and give it the label “feature request” (light-green)
If we …:
- … decide a feature request is valid and should be implemented we change the label to “enhancement” (green) or create a new issue with the label “enhancement” (green) and refer to the original feature request. Additionally we will add the issue to a milestone.
- … decide a bug is valid we will add the issue to a milestone.
If you …:
- … think we don't have enough time to resolve your issues, than you are completely correct. In this case you should fork the repository and implement the required changes and send a pull-request with an explanation of what the new code does and how it does, what it does. This will also result in a new pull-request-issue.
For those who read “Sommerville: Software Engineering”:
The label “feature request” is comparable to a “user-requirement” and the label “enhancement” should be comparable to a “functional specification”.