xianggebenben / GraphSL

Graph Source Localization Library
MIT License
7 stars 1 forks source link

[Joss Review] Community guidelines #15

Closed mbeyss closed 1 month ago

mbeyss commented 2 months ago

related to this JOSS Review

Please expand the Contact section of the README fot include

guidelines for third parties wishing to

  1. Contribute to the software
  2. Report issues or problems with the software
  3. Seek support

3rd one seems covered and the other two are no brainers (pull request and issues in this repo). Just state it explicitly please.

xianggebenben commented 2 months ago

Thank you for the suggestion. We have updated the contact section, which is shown as follows:

Contact

We welcome your contributions! If you’d like to contribute your datasets or algorithms, please submit a pull request consisting of an atomic commit and a brief message describing your contribution.

For a new dataset, please upload it to the data folder. The file should be a dictionary object saved by pickle. It contains a key "adj_mat" with the value of a graph adjacency matrix (sprase numpy array with the CSR format).

For a new algorithm, please determine whether it belongs to prescribed methods or GNN-based methods: if it belongs to the prescribed methods, add your algorithm as a new class in the GraphSL/Prescribed.py. Otherwise, please upload it as a folder under the GraphSL/GNN folder. Typically, the algorithm should include a "train" function and a "test" function, and the "test" function should return a Metric object.

Feel free to Email me (junxiang.wang@alumni.emory.edu) if you have any questions. Bug reports and feedback can be directed to the Github issues page.