From 3000a974e6344f6bcd5182310b99dbfdc978b448 Mon Sep 17 00:00:00 2001 From: Ayush Shridhar Date: Tue, 14 May 2019 06:51:31 -0700 Subject: [PATCH] Move Contributing section to CONTRIBUTING.md (#406) Also add docs about bug type classifier to README.md --- CONTRIBUTING.md | 7 +++++++ README.md | 9 +-------- 2 files changed, 8 insertions(+), 8 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c59c0c06 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,7 @@ +## Contributing + +Discussions happen in #bugbug on irc.mozilla.org. + +1. [Issues marked as `good-first-bug`](https://github.com/mozilla/bugbug/labels/good-first-bug) are self-contained enough that a contributor should be able to work on them. +2. [Issues marked as `reserved-for-beginners`](https://github.com/mozilla/bugbug/labels/reserved-for-beginners) are reserved for people who have never contributed to the project before. +3. Issues are to be considered as not assigned, until there is a PR linked to them. diff --git a/README.md b/README.md index e5357a87..cbf0b2fd 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,5 @@ # bugbug -## Contributing - -Discussions happen in #bugbug on irc.mozilla.org. - -1. [Issues marked as `good-first-bug`](https://github.com/mozilla/bugbug/labels/good-first-bug) are self-contained enough that a contributor should be able to work on them. -2. [Issues marked as `reserved-for-beginners`](https://github.com/mozilla/bugbug/labels/reserved-for-beginners) are reserved for people who have never contributed to the project before. -3. Issues are to be considered as not assigned, until there is a PR linked to them. - ## Classifiers - **bug vs feature** - Bugs on Bugzilla aren't always bugs. Sometimes they are feature requests, refactorings, and so on. The aim of this classifier is to distinguish between bugs that are actually bugs and bugs that aren't. The dataset currently contains 2110 bugs, the accuracy of the current classifier is ~93% (precision ~95%, recall ~94%). @@ -25,6 +17,7 @@ Discussions happen in #bugbug on irc.mozilla.org. - **qaneeded** - The aim of this classifier is to detect bugs that would need QA verification. +- **bugtype** - The aim of this classifier is to classify bugs according to their type. ## Setup