jaraco / jaraco/skeleton

Create contributing guide

Open
#100 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
150
Forks
38
Avg merge
1m
Merged PRs (30d)
1

Description

Before I read the article about skeleton, I was confused about various files such as *.egg-info etc. not being automatically excluded by .gitignore in one of the downstream skeleton projects, because repo-local .gitignore files are a very common practice nowadays.

Only later I found this https://blog.jaraco.com/skeleton/#ignoring-artifacts.

Making a simple guide for new contributors might be helpful to get them started and prevent from commiting files they don't intend to commit.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the linked skeleton article, especially its section on ignoring artifacts, and inspect the repository for existing contributor documentation. Add a simple guide for new contributors that explains files such as *.egg-info and how to avoid committing unintended artifacts; done means the guidance is easy to find and addresses the confusion described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.