diff --git a/README.md b/README.md index 453ca04..c7bdac0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # first-timers-only-app -## Statement: +## Statement: (boring first line) A bot that ensures exactly one newcomer issue is assigned per person so that it’s fair for all newcomers. Additionally, it encourages the no-more-newcomers to take up challenging issues once they’re comfortable with the workflow after having tackled a newcomer issue. -## How it works: +## How it works: (how awesome it is) 1. Whenever a user comments on any issue, it will be detected using “issue_comment” event. 2. The label of the issue is returned in the payload response of the said event. @@ -14,8 +14,8 @@ A bot that ensures exactly one newcomer issue is assigned per person so that it 6. If a match is found, then using the user details from payload returned on the issue_comment event, we’ll search all the issues of the [repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository), for the detected label to check if the commenter is assigned one. 7. In case a match is found, we will create a comment to inform the user that they cannot claim more than one new-comers issue. -## Future Scope +## Future Scope (hopes are high) Using fuzzy logic in natural language processing on some standard phrases we will detect if the commenter is trying to claim the issue. We might use npm module nlp-toolkit for the same. -## Have a look! +## Have a look! (tell us how is it) ![Our working bot](Snapshots/readmeSS.png)