feat: security and funding files and format docs

This commit is contained in:
Bart van der Braak 2024-02-18 16:26:56 +01:00
parent 755f49f4f5
commit 275144aef8
5 changed files with 51 additions and 13 deletions

View file

@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our Examples of behavior that contributes to a positive environment for our
community include: community include:
* Demonstrating empathy and kindness toward other people - Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences - Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback - Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes, - Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience and learning from the experience
* Focusing on what is best not just for us as individuals, but for the - Focusing on what is best not just for us as individuals, but for the
overall community overall community
Examples of unacceptable behavior include: Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or - The use of sexualized language or imagery, and sexual attention or
advances of any kind advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks - Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment - Public or private harassment
* Publishing others' private information, such as a physical or email - Publishing others' private information, such as a physical or email
address, without their explicit permission address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a - Other conduct which could reasonably be considered inappropriate in a
professional setting professional setting
## Enforcement Responsibilities ## Enforcement Responsibilities

View file

@ -18,11 +18,13 @@ To get started with contributing, please follow these steps:
## Code Style ## Code Style
We follow a specific code style in this project to maintain consistency. Please make sure to adhere to the following guidelines by running ESLint and Prettier: We follow a specific code style in this project to maintain consistency. Please make sure to adhere to the following guidelines by running ESLint and Prettier:
```sh ```sh
pnpm run format && pnpm run lint pnpm run format && pnpm run lint
``` ```
Also: Also:
- Follow naming conventions for variables, functions, and classes. - Follow naming conventions for variables, functions, and classes.
- Write clear and concise comments to explain your code. - Write clear and concise comments to explain your code.

1
.github/FUNDING.yml vendored Normal file
View file

@ -0,0 +1 @@
custom: https://ko-fi.com/bartvdbraak

View file

@ -1,10 +1,13 @@
## Description ## Description
[Provide a brief description of the changes made in this pull request.] [Provide a brief description of the changes made in this pull request.]
## Related Issue ## Related Issue
[Closes/Fixes/Resolves #Issue_Number] [Closes/Fixes/Resolves #Issue_Number]
## Checklist ## Checklist
Please make sure to review and check the following before submitting your pull request: Please make sure to review and check the following before submitting your pull request:
- [ ] I have tested these changes locally and they work as intended. - [ ] I have tested these changes locally and they work as intended.
@ -17,12 +20,15 @@ Please make sure to review and check the following before submitting your pull r
- [ ] I have added appropriate labels and milestones (if applicable). - [ ] I have added appropriate labels and milestones (if applicable).
## Screenshots (if applicable) ## Screenshots (if applicable)
[Add any relevant screenshots or images to assist in understanding the changes.] [Add any relevant screenshots or images to assist in understanding the changes.]
## Additional Information (optional) ## Additional Information (optional)
[Add any additional context or information about the changes made, if necessary.] [Add any additional context or information about the changes made, if necessary.]
## Checklist for Reviewers (optional) ## Checklist for Reviewers (optional)
Reviewers can use this checklist as a guide while reviewing the pull request: Reviewers can use this checklist as a guide while reviewing the pull request:
- [ ] The changes fulfill the requirements of the related issue(s). - [ ] The changes fulfill the requirements of the related issue(s).
@ -31,4 +37,3 @@ Reviewers can use this checklist as a guide while reviewing the pull request:
- [ ] The changes include appropriate test coverage. - [ ] The changes include appropriate test coverage.
- [ ] The tests pass successfully. - [ ] The tests pass successfully.
- [ ] The branch has been rebased onto the latest upstream changes (if necessary). - [ ] The branch has been rebased onto the latest upstream changes (if necessary).

30
.github/SECURITY.md vendored Normal file
View file

@ -0,0 +1,30 @@
# Security Policy
## Supported Versions
Use the latest version of Omnidash for the latest security updates.
## Reporting Vulnerabilities
To report a security issue, please email [bart@vanderbraak.nl](mailto:bart@vanderbraak.nl) with a detailed description and steps to reproduce. Do not file a public issue for security vulnerabilities.
### Response Timeline
We aim to respond to security reports within 48 hours, and to patch the issue within a reasonable timeframe depending on the severity.
### Responsible Disclosure
Please allow us a reasonable timeframe to address the issue before publicly disclosing it.
### Acknowledgements
We appreciate the responsible disclosure of issues by our users and will acknowledge contributors in our release notes.
## Security Best Practices
- Ensure you are running the latest version of Omnidash.
- Follow secure password and authentication practices.
## Contact Alternatives
If you are unable to send an email, please open an issue on GitHub without disclosing details such that we can establish a alternative form of communication.