Update contributor list, add citation metadata, and enhance documentation #100
Conversation
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
Adds three new contributors to reflect current project team composition and ensure proper attribution for ongoing development efforts.
Enables proper academic attribution by providing standardized citation information for the Flash Dynamic Mask Attention research work. Includes author details, paper reference, and DOI for the arXiv preprint "Trainable Dynamic Mask Sparse Attention".
Establishes community standards and behavioral expectations for contributors. Includes enforcement guidelines with escalating consequences from warnings to permanent bans, and designates losercheems@gmail.com as the contact for reporting violations. Based on Contributor Covenant version 2.1 with Mozilla-inspired enforcement ladder.
Establishes clear contribution guidelines covering bug reports, feature requests, development setup, and pull request processes. Includes specific guidance for CUDA development, testing requirements, and performance benchmarking to ensure quality contributions to the Flash Dynamic Mask Attention library.
Establishes security guidelines for CUDA kernel usage, dependency management, and memory safety considerations. Provides clear vulnerability reporting procedures with contact information and response timelines. Includes security best practices for environment isolation, input validation, and resource monitoring to help users safely integrate the library.
Renames benchmark script filenames to remove "benchmark_" prefix for cleaner naming. Updates performance comparison description to reference SDPA instead of Flash Attention for accuracy. Removes outdated MQAR benchmark section that is no longer relevant. Adds comprehensive contribution guidelines including bug reporting, feature requests, code contributions, and community standards to encourage open source participation.
Simplifies benchmark script names and descriptions for better clarity. Removes MQAR benchmark section as it's no longer part of the core suite. Adds comprehensive contributing guidelines including bug reporting, feature requests, and development workflow to encourage community participation.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
LoserCheems
requested review from
Evanwu1125,
SNHuan,
Copilot and
wubingheng111
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive documentation and community infrastructure improvements to establish proper project governance and enhance user experience. The changes focus on attribution, community guidelines, and documentation clarity.
- Establishes comprehensive community infrastructure with Code of Conduct, contributing guidelines, and security policies
- Adds proper academic citation metadata and updates contributor attribution
- Updates documentation for clarity and removes deprecated benchmark references
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| SECURITY.md | New comprehensive security policy covering CUDA code execution, vulnerability reporting, and best practices |
| CONTRIBUTING.md | New detailed contributing guidelines with development setup, testing procedures, and CUDA development standards |
| CODE_OF_CONDUCT.md | New Contributor Covenant Code of Conduct to establish community standards |
| CITATION.cff | New citation metadata file for academic use with all contributors listed |
| AUTHORS | Updates contributor list with new team members and removes external contributor |
| README.md | Adds contributing section and updates benchmark script references |
| README_zh.md | Chinese translation updates matching English README changes |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
#101
Introduce new contributors for proper attribution, add citation metadata for academic use, establish a Contributor Covenant Code of Conduct, and provide comprehensive contributing and security guidelines to improve community engagement and project safety. Update benchmark scripts and README for clarity and accuracy.