-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: clarify purpose of preferred contact method field
- Loading branch information
1 parent
3ab0bde
commit 77f9176
Showing
3 changed files
with
3 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,13 +2,13 @@ | |
title: Required. Your project title. | ||
tagline: "Required. 1-2 sentences that describe your project. An aside: if you use a colon in a field value, you must wrap the entire phrase in quotes. Otherwise, quotes are not required." | ||
maintainer: Required. Name of the person responsible for maintaining this project page. For internal use/reference - not posted to the website. | ||
preferred contact method: "Required if the preferred way for users to reach out for help is something other than creating an issue in the project's GitHub repo. Examples: link to Image.sc forum, or email in the format of mailto:[email protected]" | ||
#project type - Required. Pick one of the three options - delete the other two. | ||
project type: [OSSI - current, OSSI - alumni, Other] | ||
OSSI proposal link: Required if your project is OSSI-funded. Preferred - upload the proposal as a PDF to `public/proposals` and provide the link in the format `../../proposals/PROPOSAL.pdf`. Other option - URL to the externally hosted proposal. | ||
github link: Required. Link to GitHub repository | ||
documentation link: Required. Link to documentation - can be the same as the GitHub repo if the README is the documentation | ||
installation instructions link: Required. Link to installation instructions - can be the same as the GitHub repo | ||
preferred contact method: "Creates the link for the 'Reach out for help' button on the project page. Encouraged if there is a preferred way for users to reach out for help other than creating an issue in the project's GitHub repo. Examples: link to Image.sc forum, or an email in the format of mailto:[email protected]." | ||
how to cite text: "If your software doesn't have an associated published paper or DOI, delete or comment-out this field to use your GitHub repo as the default. Otherwise, provide the citation for your software - wrap in quotes to ensure colons are interpreted correctly. " | ||
how to cite link: "https://doi.org/example - wrap entire link in quotes. If a DOI is not available, then delete or comment-out this field to use your GitHub repo as the default." | ||
additional links array: | ||
|