add contribution guidelines #71
Conversation
Codecov Report
@@ Coverage Diff @@
## main #71 +/- ##
==========================================
- Coverage 67.16% 66.17% -0.99%
==========================================
Files 2 2
Lines 67 68 +1
==========================================
Hits 45 45
- Misses 22 23 +1
Continue to review full report at Codecov.
|
| * Keep things modular! If you are fixing/adding multiple things, do so via separate issues/PR's to streamline review and merging. | ||
| * It is recommended that you set up [JuliaFormatter](https://domluna.github.io/JuliaFormatter.jl/dev/) (also see [VSCode extension](https://marketplace.visualstudio.com/items?itemName=singularitti.vscode-julia-formatter)). A GitHub action will check that code adheres to the style guide. | ||
|
|
||
| ## Getting Started |
There was a problem hiding this comment.
How necessary is this in CONTRIBUTING.md? I'm assuming that stuff like running git clone ..., activating a Julia environment, etc would be mentioned here.
But wouldn't the people who would be looking at this file already have the essential know-how of doing all that?
There was a problem hiding this comment.
I guess the answer to this depends upon how many people you think are out there who can write decent Julia code, might be interested in contributing some of their code to a package, but haven't actually developed packages before. Given that I was such a person relatively recently (and was one in Python a couple years before that), I tend to think there are a fair number, but I may be biased due to personal experience... ;) At any rate, I don't think it hurts to have it there...
There was a problem hiding this comment.
Rather than actually writing a new guide, I decided to just compile some other nice resources.
| @@ -12,10 +12,8 @@ Documentation is in progress [over here](https://aced-differentiate.github.io/At | |||
|
|
|||
| 2. Go and try out the example in examples/example1/ – it has its own README file with detailed instructions. | |||
|
|
|||
There was a problem hiding this comment.
I think it might help to put a quick note on how to actually use the package here (like ] add AtomicGraphNets, and variants).
examples/4_sgcnn/sgcnn.jl
Outdated
| @@ -10,18 +10,17 @@ using Random | |||
| using ChemistryFeaturization | |||
| using AtomicGraphNets | |||
| using Serialization | |||
| <<<<<<< HEAD | |||
| << << << < HEAD | |||
There was a problem hiding this comment.
Should this be here? Looks like this was overlooked while resolving a merge conflict...
There was a problem hiding this comment.
haha yuuup thought I'd fixed that, oops
Open to any feedback on this stuff! Does the list of tags look good? Am I missing anything?
(obviously still a work in progress, placeholders should be obvious)