Move Contributing section to CONTRIBUTING.md (#406)

Also add docs about bug type classifier to README.md
This commit is contained in:
Ayush Shridhar 2019-05-14 06:51:31 -07:00 коммит произвёл Marco
Родитель 9223954520
Коммит 3000a974e6
2 изменённых файлов: 8 добавлений и 8 удалений

7
CONTRIBUTING.md Normal file
Просмотреть файл

@ -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.

Просмотреть файл

@ -1,13 +1,5 @@
# bugbug # 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 ## 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%). - **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. - **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 ## Setup