search

epiverse-trace / blueprints

Software development blueprints for epiverse-trace
https://epiverse-trace.github.io/blueprints
Other
4 stars 4 forks source link
best-practices epiverse internal-docs onboarding r-package-development standard-operating-procedure standards

readme

CC BY 4.0 render-blueprints DOI

Welcome to this repository!

This repository stores the Epiverse TRACE Blueprints for software development. You can:

Contributions

Tell us what you think

Questions and comments on the blueprints are welcome through github issues. If you would like to suggest edits to the blueprints but do not want to make a pull request (see below), feel free to suggest these edits directly as an issue.

Contributions via pull requests

Contributions are welcome via pull requests, usually after discussing edits in an issue. The blueprints file to edit is index.qmd. This quarto file is used to render the blueprints to html. This rendering is done automatically every time index.qmd changes on the main branch. When making pull requests, it is best to only commit changes to the qmd file.

In a nutshell, the workflow for contributions would look something like:

  1. Install quarto

  2. Clone the repository using SSH; this is only needed the first time your download the git repository.

  3. Run git pull to fetch the latest version of the repository.

  4. Create a new branch to make your changes typing git checkout -b [name_of_your_branch].

  5. Make changes to the relevant quarto (file with .qmd extension), and save the file.

  6. From your terminal, run quarto render. The html output will be generated in the _book/ folder.

  7. Repeat the two previous steps as many times as needed. Commit the final changes using:

git add index.md
git commit -m "quick summary of changes"
git push --set-upstream origin [name_of_your_branch]
  1. Open a pull request on github, using your branch, and explaining briefly which changes you have made.

Notes

Please note that this project uses a Contributor Code of Conduct. By contributing, you agree to abide by its terms.

This work is licensed under a Creative Commons Attribution 4.0 International License (CC-BY).