New README proposal

[bilalesi]

Fixes #BlueBrain/nexus#4321

Description

How has this been tested?

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added necessary unit and integration tests.
• I have added screenshots (if applicable), in the comment section.

[Dinika]

Questions:

• Why is this file called NewReadme.md? Shouldn't we just change the existing README?
• In the current README, the development guidelines is just a link to a separate file development.md. Should we follow the same pattern here and put all the sections after contributing in a separate file?

[Dinika]

What's giong to go in this section? If it's empty, shouldn't we remove it for now?

[Dinika]

The last time I checked with @samuel-kerrien I learned that we should share the Github issues link instead of zenhub because zenhub is not accessible by people outside of our team (afaik).

[Dinika]

This is a personal opinion but I find this sentence a bit intimidating (the "matching our engineering standards" part esp) and not very helpful because it doesn't clarify how to contribute to the project.

I would suggest merging the "Contributing", "Reporting a bug or discussing a feature idea" and "Fixing a bug or implementing a new feature" into one section called "Contribution Guidelines" that could read something like this:

We would love for you to contribute to our project.

You can open issues on ....
Our roadmap and open tickets can be found here.
We would love for you to contribute by opening a PR. Our git workflow can be found here.

The delta project has nice section for contributions.

Other nice examples:
create react app contributing guidelines
react contribution section

[bilalesi]

@Dinika this is a draft, we will do a meeting to discuss what's the best way on how to organize the readme and what we should include or not

[danburonline]

🔔 Just as a reminder: We should add the information from the Wiki of this repository to the new README, and then remove the Wiki tab in the settings. It's quite confusing to have the external page https://bluebrainnexus.io/docs/fusion, the README, and the Wiki all together.