CONTRIBUTING.md and Open Source Documentation (English)
Practice the vocabulary and structure of CONTRIBUTING.md files, code of conduct, and open-source community documentation.
0 / 8 completed
1 / 8
What is the primary purpose of a CONTRIBUTING.md file?
CONTRIBUTING.md guides potential contributors: how to set up a dev environment, the PR process, coding standards, how to report bugs, and what kinds of contributions are welcome.
2 / 8
What does 'first-time contributor friendly' mean in an open-source project?
First-time contributor friendliness is signaled by 'good first issue' labels, detailed onboarding docs, and a welcoming code of conduct. It lowers the barrier to entry for contributors unfamiliar with the codebase.
3 / 8
What is a CLA (Contributor License Agreement)?
A CLA transfers or licenses the intellectual property rights of a contribution to the project. It ensures the project maintainers have the legal right to include and distribute the contributed code.
4 / 8
Which sentence is an example of good CONTRIBUTING.md language for reporting bugs?
Good bug reporting guidance reduces duplicate issues and provides maintainers with the information they need to reproduce and fix bugs. Minimal reproducible examples are especially valuable.
5 / 8
What is the 'Code of Conduct' in an open-source project?
A Code of Conduct (commonly the Contributor Covenant) sets community behavior standards. It defines what constitutes harassment, how to report violations, and how maintainers will respond.
6 / 8
What does 'DCO (Developer Certificate of Origin)' require contributors to do?
The DCO is a lightweight alternative to a CLA. Contributors add 'Signed-off-by: Name ' to commits, certifying they wrote the code or have the right to submit it under the project's open-source license.
7 / 8
How would a maintainer politely decline a contribution that does not fit the project's scope?
Professional open-source communication thanks contributors, explains why the contribution is not accepted, and provides a path forward (opening a discussion). This maintains a welcoming community even when declining PRs.
8 / 8
What is a 'stale bot' in GitHub open-source projects?
Stale bots help maintainers manage large issue backlogs by automatically flagging inactive issues/PRs. Contributors must respond to the stale label to keep their issue or PR open.