diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0734537 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,20 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +- Future features will be listed here + +### Changed +- Ongoing updates + +### Fixed +- Bug fixes + +--- +*[Mukller](https://github.com/Mukller)* diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..41a1331 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,32 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We pledge to make participation in our community a harassment-free experience +for everyone, regardless of age, body size, disability, ethnicity, gender identity, +level of experience, nationality, personal appearance, race, religion, or sexual identity. + +## Our Standards + +**Positive behavior includes:** +- Demonstrating empathy and kindness +- Respecting differing opinions and experiences +- Giving and gracefully accepting constructive feedback +- Focusing on what is best for the community + +**Unacceptable behavior includes:** +- Harassment, trolling, or personal attacks +- Publishing others' private information without permission +- Sexualized language or unwelcome advances + +## Enforcement + +Instances of unacceptable behavior may be reported to community leaders. +All complaints will be reviewed and investigated promptly and fairly. + +## Attribution + +Adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1. + +--- +*[Mukller](https://github.com/Mukller)* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..493d9e7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing + +Thank you for your interest in contributing! We welcome contributions of all kinds. + +## How to Contribute + +### Reporting Bugs +- Check existing [issues](../../issues) to avoid duplicates +- Open a new issue with a clear title, description, and steps to reproduce + +### Suggesting Features +- Open an issue with the `enhancement` label + +### Submitting Code + +1. **Fork** this repository +2. **Create a branch**: `git checkout -b feature/your-feature` +3. **Make your changes** and commit: `git commit -m "feat: description"` +4. **Push** and open a **Pull Request** + +## Guidelines + +- Follow existing code style and conventions +- Keep PRs focused on a single concern +- Update documentation when changing behavior +- Be respectful — see [Code of Conduct](CODE_OF_CONDUCT.md) + +--- +*[Mukller](https://github.com/Mukller)* diff --git a/README.md b/README.md index cb05508..c752848 100644 --- a/README.md +++ b/README.md @@ -166,3 +166,15 @@ If you want to fine-tune on other text datasets, you need to change `dataset_tex # Evaluation To evaluate StarCoder2 and its derivatives, you can use the [BigCode-Evaluation-Harness](https://github.com/bigcode-project/bigcode-evaluation-harness) for evaluating Code LLMs. You can also check the [BigCode Leaderboard](https://huggingface.co/spaces/bigcode/bigcode-models-leaderboard). + + +## Contributing + +We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on +how to report bugs, suggest features, and submit pull requests. + +By participating, you agree to our [Code of Conduct](CODE_OF_CONDUCT.md). + +--- + +*[Mukller](https://github.com/Mukller)*