Skip to content

Commit

Permalink
docs: Update README, CONTRIBUTING and models/README
Browse files Browse the repository at this point in the history
- Add contributing guidelines for new models.
- Add documentation for existing models.
- Add more contributors information.
  • Loading branch information
MiguelMJ committed May 31, 2021
1 parent 0f7b3a0 commit d058360
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 10 deletions.
28 changes: 20 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,20 @@ Thank you for thinking about contributing to this project! I hope you find Answe

In the [README.md](README.md) you will find the list of tasks I'm currently working on, in case you want to open a related issue or PR.

# How to contribute

1. Fork the repository [![](https://img.shields.io/github/forks/MiguelMJ/Answerable?style=social)](https://github.com/MiguelMJ/Answerable/network/members).
2. Create a new branch from the latest `dev` branch.
3. Make your changes there.
4. Commit and push to the new branch.
5. Make a pull request.

Consider running Black, Pyflakes and/or other code formatters and analyzers before submitting your changes.

## Almost directly acceptable contributions

- Making grammar corrections anywhere in [the documentation](https://github.com/MiguelMJ/Answerable/wiki) or the comments in the code (don't spam these).
- Fixing a bug. If you don't want or know how to fix it, you can still open an issue.
- Fixing a bug. If you don't want or know how to fix it, you can still **open an issue** [![](https://img.shields.io/github/issues/MiguelMJ/Answerable?logo=GitHub&style=social)](https://github.com/MiguelMJ/Answerable/issues).
- Improving a piece of code without importing a new library. The less dependencies, the better.

## Contributions subject to review
Expand All @@ -16,20 +26,22 @@ In the [README.md](README.md) you will find the list of tasks I'm currently work
- 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).
- *Notice:* Most of them require a more expert use of the [Stack Exchange API](https://api.stackexchange.com/).
- Notice that most of them require the use of the [Stack Exchange API](https://api.stackexchange.com/).

## Contributions that require a heavy justification

- Replacing a working piece of code by an new import.
- Changes in the way data is displayed.

# How to contribute
## Contributing with a new model

1. Fork the repository [![](https://img.shields.io/github/forks/MiguelMJ/Answerable?style=social)](https://github.com/MiguelMJ/Answerable/network/members).
2. Create a new branch from the latest `dev` branch.
3. Make your changes there.
4. Commit and push to the new branch.
5. Make a pull request.
I invite you to make your own model and share it, but I will only accept a model in the central repository if:

- It makes an obvious and noticeable improvement on an existing model.
- It takes into account different/more information than other models.
- It uses a new approach that no other present model has.

Don't forget do document any new model in [models/README.md](models/README.md).

# Give feedback and visibility

Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<a href="LICENSE">
<img title="MIT License" alt="license" src="https://img.shields.io/badge/license-MIT-informational?style=flat-square">
</a>
<img title="repo-size" alt="repo-size" src="https://img.shields.io/github/repo-size/MiguelMJ/Answerable?style=flat-square">
<img title="all-contributors" alt="all-contributors" src="https://img.shields.io/github/all-contributors/MiguelMJ/Answerable?color=informational&style=flat-square">
<img title="python3.8" alt="python3.8" src="https://img.shields.io/badge/python-3.8-informational?style=flat-square">
<a href="https://github.com/MiguelMJ/Answerable/wiki">
<img title="documentation" alt="documentation" src="https://img.shields.io/badge/documentation-wiki-success?style=flat-square">
Expand All @@ -19,6 +19,7 @@
</p>



Answerable is a CLI program that uses your answers on Stack Overflow to recommend you similar questions to answer.

**Preview**
Expand Down Expand Up @@ -93,6 +94,11 @@ Thanks to the people that have contributed to this project: ([emoji key](https:/

This project follows the [all-contributors](https://allcontributors.org/) specification.

#### Posts

- [*I made a recommendation system for Stack Overflow unanswered questions*](https://dev.to/miguelmj/i-made-a-recommendation-system-for-stack-overflow-unanswered-questions-280a) in DEV.to by MiguelMJ.
- <a id="blog-dennislwm" href="https://makerwork.substack.com/p/makerwork001"><i>Makerwork 001</i></a> in Makerwork by Dennis Lee

<h2 id="Contributing66">Contributing</h2>

[[TOC](#toc)]
Expand Down
2 changes: 1 addition & 1 deletion models/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Display the title of the most similar question and the values of `SizeOfQuestion
### Observations

- The code chunks in the questions are ignored (they are considered noise).
- There are extremely rare cases where the system can crash, if the question contains text that the html parser of BeautifulSoup can't recognize. This has only happened me once with a question about regular expressions.
- There are extremely rare cases where the system can crash, if the question contains text that the HTML parser of BeautifulSoup can't recognise. This has only happened me once with a question about regular expressions.
- The Similarity is squared to reduce the preference of wall of text questions.

## `content_based_0`
Expand Down

0 comments on commit d058360

Please sign in to comment.