CONTRIBUTING
Contribution Guidelines
Thank you for considering contributing to this project! We appreciate your efforts to make it better.
To contribute to this project, please follow these guidelines:
Table of Contents
- Reporting Issues
- Feature Requests
- Submitting Changes
- Coding Conventions
- Documentation
Reporting Issues
If you encounter any problems or bugs while using this project, please report them by opening a GitHub issue. Before creating a new issue, please check if a similar one already exists to avoid duplicates. When reporting issues, provide a clear and concise description of the problem, including steps to reproduce it, expected behavior, and any relevant screenshots or error messages.
Feature Requests
If you have ideas for new features or improvements, you can submit a GitHub issue as well. Clearly describe the feature or improvement you would like to see and provide any additional context or examples that might be helpful. Feature requests help us understand your needs and prioritize the project's development.
Submitting Changes
For local dashboard setup, see apps/dashboard/README.md.
To contribute code changes, follow these steps:
1. Fork the repository and create a new branch for your changes.
2. Ensure that your code follows the project's coding conventions and style guide.
3. Run pnpm verify — formatting, lint, doc references and type checks. It needs
no database and takes seconds. pnpm verify:test runs the tests for the
packages your diff touches; those do need a local libSQL server.
4. Make commits with clear and descriptive messages. Each commit should have a single logical purpose.
5. Push your branch to your forked repository.
6. Open a pull request (PR) from your branch to the original repository's main branch.
7. Provide a detailed description of your changes in the PR, including any related issues or feature requests.
A project maintainer will review your PR, provide feedback if necessary, and merge it once it meets the project's standards.
Coding Conventions
Please adhere to the existing coding conventions and style guide used in this project. Consistent coding styles improve code readability and maintainability. If you're unsure about any aspect of the coding conventions, feel free to ask for clarification in your PR.
Documentation
Improvements to documentation are always welcome. If you find any inaccuracies, missing information, or have suggestions for improving the documentation, you can contribute by submitting a PR with your changes. Make sure to clearly explain the purpose of the documentation update and provide relevant examples, if applicable.
---
SECURITY
Reporting Security Issues
The openstatus team takes security bugs in openstatus seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
To report a security issue, please reach out to us via email at ping@openstatus or on Discord
Please do the following:
- Do not run automated scanners on our infrastructure or dashboard. If you wish to do this, contact us and we will set up a sandbox for you.
- Do not take advantage of the vulnerability or problem you have discovered, for example by downloading more data than necessary to demonstrate the vulnerability or deleting or modifying other people's data,
- Do not reveal the problem to others until it has been resolved,
- Do not use attacks on physical security, social engineering, distributed denial of service, spam or applications of third parties,
- Do provide sufficient information to reproduce the problem, so we will be able to resolve it as quickly as possible. Usually, the IP address or the URL of the affected system and a description of the vulnerability will be sufficient, but complex vulnerabilities may require further explanation.
What we promise:
- We will respond to your report within 3 business days with our evaluation of the report and an expected resolution date,
- If you have followed the instructions above, we will not take any legal action against you in regard to the report,
- We will handle your report with strict confidentiality, and not pass on your personal details to third parties without your permission,
- We will keep you informed of the progress towards resolving the problem,
- In the public information concerning the problem reported, we will give your name as the discoverer of the problem (unless you desire otherwise), and
- We strive to resolve all problems as quickly as possible, and we would like to play an active role in the ultimate publication on the problem after it is resolved.
---