Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Joss Review] Community guidelines #15

Closed
mbeyss opened this issue Jul 4, 2024 · 1 comment
Closed

[Joss Review] Community guidelines #15

mbeyss opened this issue Jul 4, 2024 · 1 comment

Comments

@mbeyss
Copy link
Contributor

mbeyss commented Jul 4, 2024

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
Copy link
Owner

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.

@mbeyss mbeyss closed this as completed Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants