search

Murali-group / GraphSpace

The interactive graph sharing website.
http://graphspace.org
GNU General Public License v2.0
30 stars 41 forks source link

Add License and author info in the README.md #363

Closed lohani2280 closed 6 years ago

lohani2280 commented 6 years ago

Its generally a good practice to include a brief section in the README about the License and author info.Providing licensing and contact information is important to clarify the legal status of the project.Most of the open-source projects follow this practice.While crawling over the web, I came across this famous gist which contains a template to make good README.md.

mitchwagner commented 6 years ago

We have LICENSE.md for the license component of this issue. From a quick scan over the README, LICENSE, and CONTRIBUTING files, you are right that they do not seem to have contact information in the form of emails. The repository itself does allow users to post issues, but it might be good to have another channel for communication.

lohani2280 commented 6 years ago

@mitchwagner Yes, I have seen the LICENSE.md. But what I meant is that we should also add a License section to the README.md with a small description like "GraphSpace is available under the GNU General Public License v2.0 license. See LICENSE.md for more information" . I have seen many open source projects following this practice and that's why just though to put up my suggestion.

tmmurali commented 6 years ago

It is a good idea to add a brief section on the licence to README.md. @lohani2280 please send a patch.

adbharadwaj commented 6 years ago

@lohani2280 Don't forget to mention this issue in your pull request. It helps us track which issues have been solved.

lohani2280 commented 6 years ago

@tmmurali @adbharadwaj @mitchwagner Thanks for responding. I'll send the patch very soon.