adding contribution guidelines

ComplexData-MILA · Feb 27, 2024 · 1c5652c · 1c5652c
1 parent b2f8d25
commit 1c5652c
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -47,7 +47,12 @@ TGX implementation works with `python >= 3.9` and can be installed as follows.
 
 6. [optional] Install `mkdocs` dependencies to serve the documentation locally.
 	```
+	pip install mkdocs 
+	pip install mkdocs-material
+	pip install mkdocstrings-python
 	pip install mkdocs-glightbox
+	pip install mkdocs-jupyter
+	pip install ipython_genutils
 	```
 
 

diff --git a/docs/contribute.md b/docs/contribute.md
@@ -0,0 +1,25 @@
+<!-- # TGX -->
+![TGX logo](2023_TGX_logo.png)
+
+# TGX Community Contribution Guidelines
+
+TGX is a community driven project and we hope to continue to add new features to it so that it is useful for a wide range of analysis and scenarios. This guide documents the best way to make various types of contribution to TGX, including what is required before submitting a code change. 
+
+Contributing to TGX is more than submitting code changes, we also welcome new research suggestions, inviting new users, testing releases and improving the documentation. Raising issues on Github to point out any issues or directions of improvement are also welcome. 
+
+
+## Reporting issues on Github
+
+Creating issues on Github is a useful way to manage problems and identify priorities. When possible, please add appropriate tags to the issue you are creating. For example, if it is related to the documentation website or error in documentation, you can include the `documentation` tag. If it is related to package installation, you can add the `install` tag. Overall, combining multiple issues that are related into a single one to report is also helpful to avoid trackig too many issues. 
+
+### Bugs
+
+Bug reports are useful when they are accompanied by ways to understand and reproduce the bug. When reporting a bug, try to include detailed steps on how you encountered the bug and how to reproduce it. If you would like to propose a fix to the bug, feel free to link it to a pull request on the issue as well.
+
+### Feedbacks and Improvements
+
+Feedbacks and improvements on TGX are welcome. If you would like to see new temporal graph statistics or visualization added, feel free to reach out directly by [email](shenyang.huang@mail.mcgill.ca) or create an issue on Github. You are of course more than welcome to add visualization and statistics from your own paper as well. 
+
+## Preparing code changes
+
+in construction. 
diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@
 </h4> 
 
 TGX supports all datasets from [TGB](https://tgb.complexdatalab.com/) and [Poursafaei et al. 2022](https://openreview.net/forum?id=1GVpwr2Tfdg) as well as any custom dataset in `.csv` format. 
-TGX provides numerous temporal graph visualization plots and statistics out of the box
+TGX provides numerous temporal graph visualization plots and statistics out of the box.
 
 
 ### Data Loading ###

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -20,7 +20,6 @@ nav:
     - Tutorials:
       - Load data: tutorials/data_loader.ipynb
       - Visualization and Statistics: tutorials/data_viz_stats.ipynb
-
     - Gallery:
       - Plots by type: 
         - TEA Plots: 
@@ -57,6 +56,8 @@ nav:
           - tgbn-trade: gallery/tgbn-trade.md
           - tgbn-genre: gallery/tgbn-genre.md
           - tgbn-reddit: gallery/tgbn-reddit.md
+
+    - Contribute: contribute.md
 
 
 theme: