Contributing

Contributing Guidelines¶

Please note that this project is released with a contributor Code of Conduct. By participating in this project you agree to abide by its terms.

For contribution ideas, have a look at repository issues, and particularly the ones marked with wanted-label. Contributions must meet the list-specific inclusion criteria and the general awesome list guidelines.

Scope and inclusion criteria¶

The list-specific requirements define the scope and inclusion criteria.

• The topic must be related to research.
• The goal of the item must be to communicate guidance about conducting research.
• The list item should have long-term relevance measured in years.

List items can be in various formats: written text, slides, videos, etc.

General quality requirements¶

All awesome lists must meet certain ground rules and formatting standards. Importantly, awesome lists are curations of the best resources by topic, not everything.

The most relevant rules for new items are:

• The item must have a hyperlinked title and a description.
• The item title and description must be separated by a dash.
• The description is concise (1 sentence) and informative.
• The description starts with an uppercase character and ends with a period.
• The item uses proper grammar and consistent and correct naming¹.

Normally, the contribution should extend the existing topic sections. If a new topic section must be introduced, be advised that there must be 3 items or more. "Thin sections" are not allowed in awesome lists.

Assuming Node.js, you can check compliance with these requirements by running:

npx awesome-lint

Submitting Contributions¶

Once your suggestion or edit is ready for inclusion, open a pull request.