Skip to content
This repository has been archived by the owner on Apr 21, 2021. It is now read-only.

doc: doc fix #24

Merged
merged 4 commits into from
Jan 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/emoji-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Emoji/Type | Represents | Comments
💼 <br /> `business` | Business Development | people who execute on the business end
💻 <br /> `code` | Code | links to commits by the user on this project
🖋 <br /> `content` | Content | e.g. website copy, blog posts are separate
📖 <br /> `doc` | Documentation | links to commits by the user on this project`, Wiki, or other source of documentation
📖 <br /> `doc` | Documentation | links to commits by the user on this project, Wiki, or other source of documentation
🎨 <br /> `design` | Design | links to the logo/iconography/visual design/etc.
💡 <br /> `examples` | Examples | links to the examples
📋 <br /> `eventOrganizing` | Event Organizers | links to event page |
Expand Down
3 changes: 1 addition & 2 deletions docs/repository-maintainers.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ sidebar_label: Repository Maintainers
---

Contributors should be recognised as soon as the contribution is discovered to help ensure their efforts are not
overlooked when the list gets updated at a later date. This can be difficult for contributions that are not the
result of a commit to repository but do your best to minimise the time between the contribution and updating the list.
overlooked when the list gets updated at a later date. This can be difficult for contributions that are not the result of a commit to the repository but do your best to minimise the time between the contribution and updating the list.

> **Pro tip:** If your project is configured for [the @all-contributors bot 🤖](bot/overview)simply write a comment on an issue or pull request to recognise their contribution. For example:
>
Expand Down
6 changes: 3 additions & 3 deletions docs/specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ Open source projects should include the following mandatory items in order to su

1. A "Contributors" section in a prominent site of the project repository documentation that includes a list of all project contributors
- The goal should be to use the most prominent site of the project documentation when feasible. In many cases, this is the project README file
- Consider use of a CONTRIBUTORS file in the top level of the repository when the number of project contributors exceeds a level at which it is feasible to use the README file to acknowledge contributions. In this case, a prominent link to the CONTRIBUTORS file should be included on the README page under the "Contributors" heading
- Consider using a CONTRIBUTORS file in the top level of the repository when the number of project contributors exceeds a level at which it is unfeasible to use the README file to acknowledge contributions. In this case, a prominent link to the CONTRIBUTORS file should be included on the README page under the "Contributors" heading
2. The listings should be formatted as a table with the following information about the project contributors:
- Name
- URL link to a site where more information can be learned about the contributor. This URL may be determined by the contributor at the project's discretion.
- Indication of the Contribution Category in text or icon image format using the defined Contribution Categories and/or Contribution Categories emoji images (see below).
- An indication of the Contribution Category in text or icon image format using the defined Contribution Categories and/or Contribution Categories emoji images (see below).
- A link to the Contribution Category in text or emoji format using the defined Contribution Categories and/or [Contribution Categories emoji](emoji-key).
- The list of contributors can be spread across multiple lines (each technically being its own table) as needed.
- The order of contributors is immaterial to the spec. Order them how you wish.
3. Projects should define contributors as those who contribute to a project in any of the Contribution Categories at any level of contribution. This specification is, by definition, inclusive of all contributions. In cases where projects deviate from the Contribution Categories or require a specific contribution level in order to meet criteria as a project contributor, the project should provide explicit documentation of the definitions that satisfy the project contributor criteria in the CONTRIBUTING document or a similar prominent public document at the top level of the project repository. This specification recommends against exclusion of an individual from the Contributor list based upon perceived level of contribution. Instead, projects should use indicators of effort within a list that remains inclusive of all contributors to the project at any level of effort. If used, these effort indicators are at the discretion of the project and are not currently specified.
3. Projects should define contributors as those who contribute to a project in any of the Contribution Categories at any level of contribution. This specification is, by definition, inclusive of all contributions. In cases where projects deviate from the Contribution Categories or require a specific contribution level in order to meet criteria as a project contributor, the project should provide explicit documentation of the definitions that satisfy the project contributor criteria in the CONTRIBUTING document or a similar prominent public document at the top level of the project repository. This specification recommends against the exclusion of an individual from the Contributor list based upon the perceived level of contribution. Instead, projects should use indicators of effort within a list that remains inclusive of all contributors to the project at any level of effort. If used, these effort indicators are at the discretion of the project and are not currently specified.

> **Pro tip:** You can use [the @all-contributors bot 🤖](bot/overview) to automate acknowledging contributors to your open source projects ✨

Expand Down