Skip to content

Commit

Permalink
docs: Update CONTRIBUTING and README
Browse files Browse the repository at this point in the history
  • Loading branch information
MiguelMJ committed Apr 17, 2021
1 parent 9775bce commit fb4f874
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 11 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ In the [README.md](README.md) you will find the list of tasks I'm currently work
- Modifying or extending the displayed statistics.
- Modifying or extending the recommendation algorithm.
- Extending the documentation.
- Solving any of the tasks listed in the To Do list in the [README.md](README.md)
- Solving any of the tasks listed in the To Do list in the [README.md](README.md).
- *Notice:* Most of them require a more expert use of the [Stack Exchange API](https://api.stackexchange.com/).

## Contributions that require a heavy justification

Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
<h1 align="center">Answerable</h1>
<h3 align="center">Recommendation system for Stack Overflow unanswered questions</h3>
<p align="center">
<a href="LICENSE">
<img alt="version1.0" src="https://img.shields.io/badge/version-v1.0-informational"
<a href="LICENSE">
<img alt="license" src="https://img.shields.io/badge/license-MIT-informational">
</a>
<img alt="repo-size" src="https://img.shields.io/github/repo-size/MiguelMJ/Answerable">
Expand All @@ -17,7 +18,6 @@
</a>
</p>


Answerable is a Python program that learns from your answers in Stack Overflow and use them to recommend questions that you could answer.

**Preview**
Expand Down Expand Up @@ -107,14 +107,14 @@ This project follows the [all-contributors](https://allcontributors.org/) specif

[[TOC](#toc)]

- [x] Test all documented behaviour (argument usage).
- [x] Limit the number of answers retrieved from users with too many answers.
- Too many answers reduce the recommendation quality.
- Too many answers drastically increases the retrieval time.
- [ ] Allow said users to set which answers want to use.
- Use X newest, X most popular or the whole activity history (maybe add a time estimation for this last option).
- [x] Implement statistics for `summary` command.
- [ ] For new users without answers, we could add the option to just select questions that they would like to have answered.
- [ ] Allow users with too many answers choose which ones to use.
- Use X newest, X most popular or the whole activity history (maybe add a time estimation for this last option, as it could take several minutes to retrieve it all).
- [ ] Add the option to just select questions that they would like to have answered (useful for users without answer history).
- [ ] Store the last recommendations and update them instead of ignoring them in future calls.
- Upate means:
- Remove already answered/closed/marked as duplicate ones.
- Add the rest to the recently received, before applying the recommendation algorithm.
- [ ] Add a command to manage the cache, instead of requiring the users to do it themselves.

**Low priority**

Expand Down

0 comments on commit fb4f874

Please sign in to comment.