mirror of
https://github.com/inventree/InvenTree.git
synced 2025-07-07 14:10:55 +00:00
Add docs for governance and security (#9360)
* add docs for governance and security * fix formatting * rename page * add thread modell info * fix list rendering * Add links to the thread modell throughout the docs * add link to devsecops * fix thread / threat * fix path * text fixes
This commit is contained in:
37
docs/docs/project/governance.md
Normal file
37
docs/docs/project/governance.md
Normal file
@ -0,0 +1,37 @@
|
||||
|
||||
As a MIT licensed open-source project, there are not legal obligations for the InvenTree project team or any contributor to provide support or maintenance. The software is provided "as-is" - without warranty of any kind.
|
||||
However, the project team is committed to providing a reliable and [secure](security.md) code base with predictable upgrade paths.
|
||||
|
||||
## Team organisation
|
||||
|
||||
There is no legal entity that governs the InvenTree project at this time.
|
||||
The project is managed by a small team of volunteer developers, who are responsible for the ongoing development and maintenance of the software.
|
||||
|
||||
### Maintainer
|
||||
|
||||
InvenTree was started by and is run by SchrodingersGat, who is the maintainer of the project following the [BDFL model](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life).
|
||||
Releases are made by the maintainer, who is responsible for the overall direction of the project. Any directional decisions are at the sole discretion of the maintainer.
|
||||
|
||||
### Core Team
|
||||
|
||||
A number of developers are selected to join the `core team` to help with triage and review of issues and pull requests. Core team members are part of the @inventree/triage team on GitHub and might choose to make that association public. Team members might be listed on the website.
|
||||
|
||||
The core team has moderation, triage and review permissions on most repositories of the organisation. There is no requirement (or assumption) of effort spend on the project.
|
||||
|
||||
### Proofreaders
|
||||
|
||||
The InvenTree project is translated into a number of languages using a web translation tool that requires approval of submitted strings. Members of the community can apply to be elevated to the role of `proofreader` for a specific language.
|
||||
Proofreaders are enabled to approve translations, at which point they are automatically proposed for inclusion in the code base.
|
||||
|
||||
A list of proofreaders is being maintained on [GitHub](https://github.com/inventree/InvenTree/discussions/9073)
|
||||
|
||||
## Write access to the code base
|
||||
|
||||
Write access to the code base is granted to a very small number of developers. In daily operations only the [maintainer](#maintainer) is expected to make changes to the master or stable branches.
|
||||
|
||||
To reduce the risk of losing the possibility to address security issues in a timely manner additional members are granted access.
|
||||
|
||||
The following users have write access to the code base at this time:
|
||||
|
||||
- [SchrodingersGat](https://github.com/SchrodingersGat)
|
||||
- [matmair](https://github.com/matmair)
|
55
docs/docs/project/security.md
Normal file
55
docs/docs/project/security.md
Normal file
@ -0,0 +1,55 @@
|
||||
|
||||
The InvenTree project is committed to providing a secure and safe environment for all users. We know that many of our users rely on InvenTree to manage the inventory and manufacturing for their small and mid-size businesses, and we take that responsibility seriously.
|
||||
|
||||
To that end, we have implemented a number of security measures over the years, which we will outline in this document.
|
||||
|
||||
## Organisational measures
|
||||
|
||||
The InvenTree project is managed by a small team of developers, who are responsible for the ongoing development and maintenance of the software. Two geographically distributed users have administrative access to the InvenTree codebase. Merges are only done by one of these two users, the maintainer Oliver.
|
||||
Read the Project [Governance](governance.md) document for more information.
|
||||
|
||||
InvenTree is open-source, and we welcome contributions from the community. However, all contributions are reviewed and scrutinised before being merged into the codebase.
|
||||
|
||||
We provide a written [Security Policy]({{ sourcefile("SECURITY.md") }}) in our main repo to ensure that all security issues are handled in a timely manner.
|
||||
|
||||
If we become aware of a security issue, we will take immediate action to address the issue, and will provide a public disclosure of the issue once it has been resolved. We support assigning CVEs to security issues where appropriate. Our [past security advisories can be found here](https://github.com/inventree/InvenTree/security/advisories).
|
||||
|
||||
## Technical measures
|
||||
|
||||
### Code hosting
|
||||
|
||||
The InvenTree project is hosted on GitHub, and we rely on the security measures provided by GitHub to help protect the integrity of the codebase.
|
||||
|
||||
Among those are:
|
||||
|
||||
- Short-lived tokens where possible
|
||||
- Dependabot for automated dependency updates / alerts
|
||||
- Integrated security reporting
|
||||
- (Optional but encouraged) Two-factor authentication for user accounts
|
||||
- (Optional but encouraged) Signed commits / actions
|
||||
|
||||
### Code style
|
||||
|
||||
We enforce style and security checks in our CI/CD pipeline, and we have several automated tests to ensure that the codebase is secure and functional.
|
||||
Checks are run on every pull request, and we require that all checks pass before a pull request can be merged.
|
||||
|
||||
### Current versions
|
||||
|
||||
InvenTree is built using the Django framework, which has a strong focus on security. We follow best practices for Django development, and we are committed to keeping the codebase up-to-date with the latest security patches and within supported versions.
|
||||
|
||||
### Test coverage
|
||||
|
||||
We run coverage tests on our codebase to ensure that we have a high level of test coverage above 90%. This is public and can be found [here](https://app.codecov.io/gh/inventree/InvenTree).
|
||||
|
||||
### Pinning dependencies
|
||||
|
||||
We are pinning dependencies to specific versions - aiming for complete reproducibility of builds - wherever possible. Combined with continuous OSV checks, we are able to react quickly to security issues in our dependencies.
|
||||
|
||||
## Best practices
|
||||
|
||||
We follow most of GitHubs community best practices, check our compliance [here](https://github.com/inventree/InvenTree/community).
|
||||
|
||||
We also follow OpenSSF recommendations where applicable and take part in multiple of their security efforts:
|
||||
|
||||
- OSSF Best Practices, currently at a [level of passing](https://www.bestpractices.dev/de/projects/7179)
|
||||
- OSSF Scorecard, running with each merge [check current state](https://securityscorecards.dev/viewer/?uri=github.com/inventree/InvenTree)
|
Reference in New Issue
Block a user