Developer guide: Include instructions on how to setup a sandbox folder for testing in Intellij

[yong24s]

Following v1.11 requirements, the generated report folder will be changed from reposense-report to docs.

As our documentation files are also in docs, this impedes with development and testing.

Let's move our documentation files to another folder.

[damithc]

Not sure if this is necessary. The report should be in target-folder/docs, not necessarily {root}/docs

[yong24s]

Yes. I got IntelliJ to run in a "sandboxed" folder.

I will update the developer guide to include this requirement.

Will update this issue.

[damithc]

@yong24s is this still applicable?

[yong24s]

Yes, it is a good practice.

Background:

We clone repositories into the root of our project for testing with assumption that git-clone never fails for positive tests.

If the git-clone were to fail, the next git operation may get executed on our git working directory. This can potentially destroy our uncommitted changes.

[Tejas2805]

@yong24s Hi, have the instructions been included? Or can I work on this issue?

[yong24s]

@Tejas2805, yes you may work on this issue but I suggest you to take a look at #659 first, as the issue is better defined.