Skip to content

Commit

Permalink
Getting Started with Contributing to RDKit (rdkit#7813)
Browse files Browse the repository at this point in the history
* test fork commit

test complete, remove file

squashed test

* add skeleton file

* outline of the Python dev section

* add if not developer

* Update GettingStartedWithContributing.md

* strcuture things a bit more

* add summary of blog post

* update dev instructions

* update for devs

* Add example on how to add unit tests

* add style section

* added github issues and discussion

* add style example image

* update for devs

* add hyperlinks

* Move CodingStandards to GettingStartedWithContributing

Also updated the supported C++ version to C++17. I put in g++ 8.0 as a
rough guess of a version expected to support this standard.

* add initial git pull steps

* add how to check for bugs

* added how to contribute code

* Add a section on how to run tests

* Update "running tests" section

Fix a MD syntax error and add a paragraph encouraging people to run the tests! :-)

* add pullreq

* add pull_req2

* Add links to new GettingStartedWithContributing.md

* add missing image files

* update what and how section

* update how to pull req

* Update GettingStartedWithContributing.md

* update running tests

* tweak formatting

* start docs contribs

* typo fixes

* add rst overview

* move image to correct location, update python and C++ sections

* add how to do Python bindings

* Add batch 1 of Greg's suggested changes

Co-authored-by: Greg Landrum <[email protected]>

* add Greg changes

* Revert "add Greg changes"

This reverts commit 3f7d8ee.

* make Greg's (actual) changes

---------

Co-authored-by: mikey <[email protected]>
Co-authored-by: martin-sicho <[email protected]>
Co-authored-by: dehaenw <[email protected]>
Co-authored-by: Franz Waibl <[email protected]>
Co-authored-by: Rasmus Mejborg Borup <[email protected]>
Co-authored-by: Ivan Tubert-Brohman <[email protected]>
Co-authored-by: Ivan Tubert-Brohman <[email protected]>
Co-authored-by: Greg Landrum <[email protected]>
  • Loading branch information
9 people authored Dec 6, 2024
1 parent 5407a3f commit 090dba9
Show file tree
Hide file tree
Showing 7 changed files with 588 additions and 51 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
See Docs/Book/GettingStartedWithContributing.md
587 changes: 587 additions & 0 deletions Docs/Book/GettingStartedWithContributing.md

Large diffs are not rendered by default.

Binary file added Docs/Book/images/pull_req1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Docs/Book/images/pull_req2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Docs/Book/images/rdkit_fork_clone.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Docs/Book/images/style.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 0 additions & 51 deletions Docs/Code/CodingStandards.md

This file was deleted.

0 comments on commit 090dba9

Please sign in to comment.