search

ciselab / TestGenie

TestGenie - an IntelliJ plugin that natively integrates EvoSuite into the IDE. EvoSuite is an automated test suite generation tool using evolutionary algorithms. Used for research @ SERG, TU Delft.
MIT License
1 stars 0 forks source link

Refining documentation #164

Closed jzelenjak closed 2 years ago

jzelenjak commented 2 years ago

Description of changes made

TestGenie documentation (README.md and README_contributors.md) has been updated to be up-to-date with the current state of the plugin.

Why is merge request needed

This merge request is needed since having a thorough up-to-date documentation is important for our project.

Other notes

Closes #137

What is missing?

bolkhod commented 2 years ago

We should probably remove line 13 of the README.md - "This specific section is a source for the plugin.xml..."

Will do

bolkhod commented 2 years ago

Without nitpicking the documentation looks fine. I think it can be merged because it is a good improvement.

However, it is not complete.

1. Most probably next week we will need to update the parts that are not implemented.

2. Furthermore, we should probably add the disclaimer to the README.md about the responsibility of the user for their tests and hat TestGenie is not a solution for all of your problems.

3. I think that there are a couple of places in the CONTRIBUTING.md where we could include links to the different parts of the document, similar to the link the README.md file.

4. The CONTRIBUTING.md will also have to be updated if there are major changes next week.

5. Bundles section is missing an overview of the section like the other sections.

6. Will the .pngs be updated to white theme and colorblind friendly images?

Overall, the work looks well. Thank you very much for your work, time and effort. Good job! 🙂 👍

We will be sure to remember this!