Consolidate Contributor Guides Across Multiple Repositories #18

New issue

Open

opened 2023-06-14 08:09:25 +00:00 by realloc · 2 comments

realloc commented

2023-06-14 08:09:25 +00:00

Owner

This task involves identifying all relevant contributor guides, reviewing them for consistency and compatibility, and combining them into a new, centralized guide. The end result should be a well-organized and comprehensive resource for all contributors across our repositories.

Currently, our set of repositories follows similar development and planning rules, and each has its own contributor's guide. To improve organization and accessibility, it is suggested to consolidate these guides into a single location. This task involves identifying all relevant contributor guides, reviewing them for consistency and compatibility, and combining them into a new, centralized guide. The end result should be a well-organized and comprehensive resource for all contributors across our repositories.

realloc added the

documentation

label 2023-06-14 08:09:25 +00:00

realloc self-assigned this 2023-06-14 08:09:25 +00:00

realloc added this to the FLOSS Best Practices Criteria (Passing) project 2024-02-02 19:10:15 +00:00

realloc commented

2024-02-02 19:11:42 +00:00

Author

Owner

Covers requirement from the FLOSS Best Practices Criteria (Passing Badge)

The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software.

Covers requirement from the FLOSS Best Practices Criteria (Passing Badge) >The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software.

realloc removed their assignment 2024-02-02 19:11:50 +00:00

realloc commented

2024-02-02 19:15:50 +00:00

Author

Owner

Covers requirement from the FLOSS Best Practices Criteria (Passing Badge)

The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?)

Details:
We presume that projects on GitHub use issues and pull requests unless otherwise noted. This information can be short, e.g., stating that the project uses pull requests, an issue tracker, or posts to a mailing list (which one?)

Rationale:
Contributors need to understand not only how to contribute, but also the overall contribution process, so that they'll understand how their work could be incorporated and what the expectations are after the initial submission. This means that wherever the project describes how to contribute, the project must include (directly or by reference) information on the contribution process. Note that criterion "interact" (listed earlier) requires that the contribution information be on the project website.

The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard).

Covers requirement from the FLOSS Best Practices Criteria (Passing Badge) >The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) > Details: > We presume that projects on GitHub use issues and pull requests unless otherwise noted. This information can be short, e.g., stating that the project uses pull requests, an issue tracker, or posts to a mailing list (which one?) > Rationale: > Contributors need to understand not only how to contribute, but also the overall contribution process, so that they'll understand how their work could be incorporated and what the expectations are after the initial submission. This means that wherever the project describes how to contribute, the project must include (directly or by reference) information on the contribution process. Note that criterion "interact" (listed earlier) requires that the contribution information be on the project website. >The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard).