-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor README per other packages by author.
- Loading branch information
Showing
5 changed files
with
152 additions
and
81 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| ^.*\.Rproj$ | ||
| ^\.Rproj\.user$ | ||
| ^\.travis\.yml$ | ||
| ^codecov\.yml$ | ||
| ^appveyor\.yml$ | ||
| ^\.github$ | ||
| ^CITATION\.cff$ | ||
| ^CodeofConduct\.md$ | ||
| ^CODE_OF_CONDUCT.md$ | ||
| ^SECURITY.md$ | ||
| ^CONTRIBUTING.md$ | ||
| ^LICENSE$ |
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 |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # Contributor Code of Conduct | ||
| ## Our Pledge | ||
| In the interest of fostering an open and welcoming environment, we as | ||
| contributors and maintainers pledge to making participation in our project and | ||
| our community a harassment-free experience for everyone, regardless of age, body | ||
| size, disability, ethnicity, gender identity and expression, level of | ||
| experience, nationality, personal appearance, race, religion, or sexual identity | ||
| and orientation. | ||
|
|
||
| ## Our Standards | ||
| Examples of behavior that contributes to creating a positive environment include: | ||
|
|
||
| * Using welcoming and inclusive language | ||
| * Being respectful of differing viewpoints and experiences | ||
| * Gracefully accepting constructive criticism | ||
| * Focusing on what is best for the community | ||
| * Showing empathy towards other community members | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
|
|
||
| * The use of sexualized language or imagery and unwelcome sexual attention or | ||
| advances | ||
| * Trolling, insulting/derogatory comments, and personal or political attacks | ||
| * Public or private harassment | ||
| * Publishing others' private information, such as a physical or electronic | ||
| address, without explicit permission | ||
| * Other conduct which could reasonably be considered inappropriate in a | ||
| professional setting | ||
|
|
||
| ## Our Responsibilities | ||
| Project maintainers are responsible for clarifying the standards of acceptable | ||
| behavior and are expected to take appropriate and fair corrective action in | ||
| response to any instances of unacceptable behavior. | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, or reject | ||
| comments, commits, code, wiki edits, issues, and other contributions that are | ||
| not aligned to this Code of Conduct, or to ban temporarily or permanently any | ||
| contributor for other behaviors that they deem inappropriate, threatening, | ||
| offensive, or harmful. | ||
|
|
||
| ## Scope | ||
| This Code of Conduct applies both within project spaces and in public spaces | ||
| when an individual is representing the project or its community. Examples of | ||
| representing a project or community include using an official project e-mail | ||
| address, posting via an official social media account, or acting as an appointed | ||
| representative at an online or offline event. Representation of a project may be | ||
| further defined and clarified by project maintainers. | ||
|
|
||
| ## Enforcement | ||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
| reported by contacting the project maintainer at `avraham dot adler at gmail` | ||
| `dot com`. The project team will review and investigate all complaints, and will | ||
| respond in a way that it deems appropriate to the circumstances. The project | ||
| team is obligated to maintain confidentiality with regard to the reporter of an | ||
| incident. Further details of specific enforcement policies may be posted | ||
| separately. | ||
|
|
||
| Project maintainers who do not follow or enforce the Code of Conduct in good | ||
| faith may face temporary or permanent repercussions as determined by other | ||
| members of the project's leadership. | ||
|
|
||
| ## Attribution | ||
| This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
| version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | ||
|
|
||
| [homepage]: http://contributor-covenant.org | ||
| [version]: http://contributor-covenant.org/version/1/4/ |
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 |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| title: Contributions | ||
| --- | ||
|
|
||
| # Contributions | ||
| Please ensure that all contributions comply with both | ||
| [R and CRAN standards for packages](https://cran.r-project.org/doc/manuals/r-release/R-exts.html). | ||
|
|
||
| ## Versioning | ||
| This project attempts to follow [Semantic Versioning](https://semver.org/). | ||
| However, so long as the package remains in its experimental development | ||
| state---noted by a 0 major version---the API may change without incrementing the | ||
| major version. Please read the development notes | ||
| ([NEWS](https://CRAN.R-project.org/package=minimaxApprox/news.html)) carefully. | ||
| Breaking changes will be prefaced by "**Breaking:**". | ||
|
|
||
| ## Changelog | ||
| This project attempts to follow the changelog system at | ||
| [keep a changelog](https://keepachangelog.com/). | ||
|
|
||
| ## Dependencies | ||
| This project intends to have as few dependencies as possible. Please consider | ||
| that when writing code. | ||
|
|
||
| ## Style | ||
| Please conform to this | ||
| [coding style guide](https://www.avrahamadler.com/coding-style-guide/) as best | ||
| possible. | ||
|
|
||
| ## Documentation | ||
| Please provide valid .Rd files and **not** roxygen-style documentation. | ||
|
|
||
| ## Tests | ||
| Please review the current test suite and supply similar `tinytest`-compatible | ||
| unit tests for all added functionality. | ||
|
|
||
| ## Submission | ||
| If you would like to contribute to the project, it may be prudent to first | ||
| contact the maintainer via email. A request or suggestion may be raised as an | ||
| issue as well. To supply a pull request (PR), please: | ||
|
|
||
| 1. Fork the project and then clone into your own local repository | ||
| 2. Create a branch in your repository in which you will make your changes | ||
| 3. Ideally use -s to sign-off on commits under the | ||
| [Developer Certificate of Origin](https://developercertificate.org/). | ||
| 4. If possible, sign commits using a GPG key. | ||
| 5. Push that branch and then create a pull request | ||
|
|
||
| At this point, the PR will be discussed and eventually accepted or rejected by | ||
| the lead maintainer. |
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 |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: Security | ||
| --- | ||
| # Security | ||
| ## Expectations | ||
| This package is a calculation engine and requires no secrets or private | ||
| information. It is checked for memory leaks prior to releases to CRAN using | ||
| ASAN/UBSAN. Dissemination is handled by CRAN. Bugs are reported via the tracker | ||
| and handled as soon as possible. | ||
|
|
||
| ## Assurance | ||
| The threat model is that a malicious actor would "poison" the package code by | ||
| adding in elements having nothing to do with the package's purpose but which | ||
| would be used for malicious purposes. This is protected against by having the | ||
| email account of the maintainer—used for verification by CRAN—protected by a | ||
| physical 2FA device (Yubikey) which is carried by the lead maintainer. |