Contributing

Contributing Guidelines¶

Awesome Research Guides is an open-source project hosted at

 https://github.com/nkrusch/awesome-research-guides

The project is released with a contributor Code of Conduct. By participating, you agree to abide by its terms.

Scope and inclusion criteria¶

Contributions must meet the following inclusion criteria.

• The topic is related to research.
• The content aims to communicate guidance about conducting research.
• The content has expected long-term relevance (measured in years).

List items can appear in many formats: text, slides, video, etc.

For contribution ideas, have a look at repository issues. Awesome lists are curations of the best resources by topic, not everything.

How to contribute¶

The awesome list is compiled from the references. Do not edit the readme directly -- all updates must be made in bib files.

1. Fork and clone this repository.
2. Go to references/
3. Each bib file is a list section: choose a bibliography to edit.
4. Apply edits to the bibliography. Make sure to include a one-sentence description in abstract.
5. Commit changes to the forked repository.
6. Open a pull request against the upstream repository.

Previewing¶

Using Docker, you can preview the rendered output. Run in a terminal:

docker run --rm --platform=linux/amd64 -v $(PWD):$(PWD) -w $(PWD) \
   ghcr.io/nkrusch/guides:latest \
   make

The command will produce an updated readme.md and website sources.