opensearch-project / opensearch-project/.github
[PROPOSAL] Document current security mechanisms
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 41
- Forks
- 74
- Avg merge
- 3d 19h
- Merged PRs (30d)
- 1
Description
What/Why
What are you proposing?
Users want to read up on current security measures of our repos. For example, whether we have any security scanners configured to detect accidental security leaks.
What users have asked for this feature?
I got back-channelled.
What problems are you trying to solve?
I got back-channelled and had to ask around.
We have Whitesource, Dependabot, security scanning, etc.
What is the developer experience going to be?
Read about things like Whitesource and Dependabot in SECURITY.md
Are there any security considerations?
Yes!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the repository's SECURITY.md and the current security configuration across the OpenSearch repositories. Check which mechanisms named in the issue, including Whitesource, Dependabot, and security scanning, are actually in use. Done means SECURITY.md accurately documents the current mechanisms and where users can learn more.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100