Add details to CONTRIBUTING.md

Open Beginner friendly
#2,581 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 3 days

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
80/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Read the current CONTRIBUTING.md file in the repository root. Review the linked OSGeo Committer Responsibilities Guidelines to understand the suggested additions. Draft text for the three missing sections: contributions on behalf of an employer, source of contributions (personal/public domain/compatible licenses), and preserving copyright/attribution from other projects. Ensure the changes align with the project's existing tone and license.

Written by the indexing model from the issue text.

Description

Administrative Enhancement

Problem
The OSGeo Committer Responsibilities Guidelines page has some suggestions for information to include that is currently missing from CONTRIBUTING.md. Specifically, the guidelines mention adding information about:

  • contributions developed on behalf of an employer.
  • information about contributions coming from the contributor themselves, or another valid source such as public domain code or projects with compatible licenses.
  • Preserving the copyright and attribution information for code that comes from other projects

Improvement
Additional details could be added to CONTRIBUTING.md.

Dominant language
C++
Stars
1.4k
Forks
397
Avg merge
2d 16h
Merged PRs (30d)
8

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pgRouting/pgrouting

All issues in pgRouting/pgrouting

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.