Skip to content

How to submit a contribution to the Cookbook

Jump to bottom
Stuart Chalk edited this page Mar 27, 2024 · 4 revisions

Contributions to the Cookbook are administered through the projects’ GitHub repository using the GitHub Pull Request (PR) process. Pull requests are similar to paper submissions to journals, they allow authors to submit a new contribution, and allow editors to review submissions, suggest changes, and finally accept the contribution. There are two major differences to journal submissions:

  • The PR must be submitted via a branch a repository.
  • As the PR process is administered in the projects' GitHub repository it is an open submission and review process, as it should be to be FAIR.

Contributions can be made via the following mechanisms.

Submit a PR to the Cookbook GitHub Repository

This requires the contributor has installed software to manage a local copy of a forked copy of the repository plus has the Git version control system (VCS) installed. (PyCharm and VS Code mentioned here have this capability included, as does the free software GitHub Desktop). The process is as followed:

  • Login to GitHub, go to the main page of this repo and click the Fork button (top right).
  • Fill out the 'Create new fork' page and submit. This will create the Fork (complete copy) of the Cookbook repo on the contributors GitHub account. The directions below are done using the 'forked' copy a contributor has in their GitHub account.
  • Clone the repository to your local computer, either using the GitHub link (https://github.com/GitHubUserName/WFChemCookbook.git) OR using the built in mechanism in your chosen IDE/software.
  • Create a local branch named as <initials>_contribution_<sub#> (i.e. sjc_contribution_1) (using this format will allow us to keep track of contributions).
  • Create a folder in the local contributions folder named in accordance with these guidelines.
  • Add your contribution files to the folder in the previous step again using the guidelines.
  • Once your files are complete submit a PR to the staging branch of the Cookbook project.

Submit a Contribution Issue to the GitHub Repository

  • Create your contribution in a folder as described by the following guidelines.
  • Create a zip file of your contribution folder.
  • Using the GitHub issue template for contributions, fill out the information about your contribution, and attach your zipped file.
  • Submit your contribution issue. Once verified, your zip file will be used by one of the administrators to create and submit a PR on your behalf.
Clone this wiki locally