Skip to content

A LLM trained only on data from certain time periods to reduce modern bias

Python

Add CONTRIBUTING.md with contribution guidelines

Swamy Gadilab371d95bd12a
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..1b52d6a
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,28 @@
+# Contributing to TimeCapsuleLLM
+
+Thank you for your interest in contributing! Here are some guidelines to help you get started.
+
+## Code Style
+- Follow PEP 8 style guidelines
+- Use type hints for all functions
+- Write descriptive docstrings
+- Keep lines under 120 characters
+
+## Testing
+- Write tests for new features
+- Run pytest before submitting PRs
+- Aim for 80%+ code coverage
+- Test edge cases and error conditions
+
+## Commit Messages
+- Use clear, descriptive commit messages
+- Start with a verb (Add, Fix, Update, etc.)
+- Include issue numbers when relevant
+- Example: "Add type hints to download_texts_improved.py (#16)"
+
+## Pull Requests
+- Create a new branch for each PR
+- Link related issues in the PR description
+- Ensure CI/CD checks pass
+- Request review from maintainers
+- Be prepared to address feedback