chore: prepare repository for open source release#20
Merged
Conversation
Replace {repository-url} placeholder with actual GitHub repository URL.
Replace placeholder with @Doist/frontend-product team.
This repository uses Renovate for dependency updates instead of Dependabot.
Add contribution guidelines including: - Code of Conduct reference - Open development policy - Semantic versioning explanation - Branch organization - How to propose changes - Project setup instructions - Development workflow and available commands - Pull request guidelines - Commit message guidelines (Conventional Commits)
Add Contributor Covenant v2.1 code of conduct with Doist contact email (frontend+opensource@doist.com) for enforcement.
![doistbot-app[bot]](https://avatars.githubusercontent.com/in/2345791?s=60&v=4){kind=small}
| ## Reporting a vulnerability | ||
|
|
||
| Please report any vulnerabilities by [opening an issue]({repository-url}/issues/new) and including as many details as you can. We will prioritize security reports over other issues. | ||
| Please report any vulnerabilities by [opening an issue](https://github.com/Doist/react-compiler-tracker/issues/new) and including as many details as you can. We will prioritize security reports over other issues. |
There was a problem hiding this comment.
[P2] Insecure vulnerability reporting mechanism. Directing users to report security vulnerabilities via public GitHub issues forces public disclosure of exploits before a fix can be prepared. I recommend directing these reports to a private channel (such as security@doist.com or the team email frontend+opensource@doist.com) or instructing users to use GitHub's private vulnerability reporting feature.
Member
Author
There was a problem hiding this comment.
I believe the private reporting feature is only available once the repo is public. We can follow up once that's done.
frankieyan
force-pushed
the
frankieyan/open-source-prep
branch
from
334134b to
2651f65
Compare
frankieyan
requested review from
a team and
craigcarlyle
and removed request for
a team
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR takes care of a couple of documentation/configuration loose ends:
@doist/frontend-productdependabot.ymlCONTRIBUTING.mdwith development workflow and commit guidelinesCODE_OF_CONDUCT.mdusing Contributor Covenant v2.1