docs: add community files (CODE_OF_CONDUCT, CONTRIBUTING, CITATION.cff) - #181
Open
atong01 wants to merge 1 commit into
Open
docs: add community files (CODE_OF_CONDUCT, CONTRIBUTING, CITATION.cff)#181atong01 wants to merge 1 commit into
atong01 wants to merge 1 commit into
Conversation
- Add Contributor Covenant 2.1 code of conduct - Add contributor guidelines with dev setup, PR process, testing, and pre-commit instructions - Add CITATION.cff (CFF 1.2.0) with DOIs for both Tong et al. papers: * 10.48550/arXiv.2302.00482 (Improving and Generalizing Flow-Based Generative Models) * 10.48550/arXiv.2307.03672 (Simulation-Free Schrodinger Bridges) - Update README to link CITATION.cff, CONTRIBUTING.md, and CODE_OF_CONDUCT.md
Contributor
Reviewer's GuideAdds standard community and citation documentation (CODE_OF_CONDUCT, CONTRIBUTING, CITATION.cff) and wires them into the README so contributors have clear guidance and the project is citable via GitHub’s citation integration. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="CONTRIBUTING.md" line_range="17-18" />
<code_context>
+git clone https://github.com/<your-username>/conditional-flow-matching.git
+cd conditional-flow-matching
+
+# create a conda environment with python 3.10
+conda create -n torchcfm python=3.10
+conda activate torchcfm
</code_context>
<issue_to_address>
**nitpick (typo):** Consider capitalizing "Python" here for consistency with the rest of the document.
Elsewhere you use "Python 3.10" with a capital P; please update this line to match that capitalization.
```suggestion
# create a conda environment with Python 3.10
conda create -n torchcfm python=3.10
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+17
to
+18
| # create a conda environment with python 3.10 | ||
| conda create -n torchcfm python=3.10 |
Contributor
There was a problem hiding this comment.
nitpick (typo): Consider capitalizing "Python" here for consistency with the rest of the document.
Elsewhere you use "Python 3.10" with a capital P; please update this line to match that capitalization.
Suggested change
| # create a conda environment with python 3.10 | |
| conda create -n torchcfm python=3.10 | |
| # create a conda environment with Python 3.10 | |
| conda create -n torchcfm python=3.10 |
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
1 participant
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.
Adds community and citation files to the repository.
Changes
Motivation
The repo had no CODE_OF_CONDUCT, CONTRIBUTING, or CITATION file. This adds the standard community files so contributors know how to engage and so the software is citable via DOI through GitHub's
Citation File Formatintegration.Validation
This is part of a 4-PR batch (community-docs, add-tests, bugfixes, ci-updates). All four have disjoint file sets and were validated together locally:
pytest -v --ignore=examples --ignore=runner→ 172 passed, 1 skipped, 0 failed. Coverage went from 30% → 47%.Summary by Sourcery
Add standard community and citation files and link them from the README to formalize contribution, conduct, and citation practices.
Documentation: