From 03a931c931ef01082db195ca4c2a2bbb9e610708 Mon Sep 17 00:00:00 2001 From: Jesper Dramsch Date: Sat, 11 Jan 2025 12:27:10 +0100 Subject: [PATCH] docs: add all-contributors --- .all-contributorsrc | 4 + CONTRIBUTING.md | 195 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 35 +++++++- 3 files changed, 231 insertions(+), 3 deletions(-) create mode 100644 .all-contributorsrc create mode 100644 CONTRIBUTING.md diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 00000000000..3196dcf8b59 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,4 @@ +{ + "projectName": "jesperdramsch", + "projectOwner": "python-deadlines" +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..b00d9c1f43a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,195 @@ +# Contributing to Python Deadlines + +[![pages-build-deployment](https://github.com/JesperDramsch/python-deadlines/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages)](https://github.com/JesperDramsch/python-deadlines/actions/workflows/pages/pages-build-deployment) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/jesperdramsch/python-deadlines) ![GitHub Repo stars](https://img.shields.io/github/stars/jesperdramsch/python-deadlines) [![All Contributors](https://img.shields.io/github/all-contributors/jesperdramsch/python-deadlines?color=ee8449)](#contributors) + +Thank you for your interest in contributing to Python Deadlines! This guide will help you get started with making contributions to the project. + +## Table of Contents + +- [Contributing to Python Deadlines](#contributing-to-python-deadlines) + - [Table of Contents](#table-of-contents) + - [Ways to Contribute](#ways-to-contribute) + - [Adding or Updating Conference Information](#adding-or-updating-conference-information) + - [Optional Fields](#optional-fields) + - [Development Setup](#development-setup) + - [Making Changes](#making-changes) + - [Pull Request Guidelines](#pull-request-guidelines) + - [Using All-Contributors Bot](#using-all-contributors-bot) + - [Code Quality](#code-quality) + - [Getting Help](#getting-help) + - [Code of Conduct](#code-of-conduct) + - [License](#license) + +## Ways to Contribute + +You can contribute in several ways: + +- Adding or updating conference information +- Improving documentation +- Fixing bugs +- Adding new features +- Reviewing pull requests + +## Adding or Updating Conference Information + +1. Fork the repository +2. Edit `_data/conferences.yml` +3. Follow this format for conference entries: + +```yaml +- conference: BestConf # Title of conference + year: 2024 # Year + link: https://example.com # Conference website URL + cfp: '2024-06-01 23:59:59' # Submission deadline + place: Berlin, Germany # Location + start: 2024-09-15 # Conference start date + end: 2024-09-18 # Conference end date + sub: PY # Conference type (see below) +``` + +Required fields: + +- `conference`: Conference name +- `year`: Conference year +- `link`: Conference website URL +- `cfp`: Call for Proposals deadline +- `place`: Location +- `start`: Conference start date +- `end`: Conference end date +- `sub`: Conference type + +Conference types (`sub`): + +- `PY`: General Python +- `SCIPY`: Scientific Python +- `DATA`: Python for Data +- `WEB`: Python for Web +- `BIZ`: Python for Business +- `GEO`: Python for Earth + +### Optional Fields + +You can enhance your entry with these optional fields: + +- `alt_name`: Alternative conference name +- `cfp_link`: Specific CFP page URL +- `cfp_ext`: Extended deadline +- `workshop_deadline`: Workshop submission deadline +- `tutorial_deadline`: Tutorial submission deadline +- `timezone`: IANA timezone (defaults to AoE if omitted) +- `sponsor`: Sponsorship page URL +- `finaid`: Financial aid information URL +- `twitter`: Conference Twitter handle +- `mastodon`: Conference Mastodon URL +- `note`: Additional important information +- `location`: Venue coordinates for the map + +## Development Setup + +1. Install Jekyll (requires Ruby): + +```bash +gem install bundler jekyll +``` + +2. Clone your fork: + +```bash +git clone https://github.com/YOUR-USERNAME/python-deadlines.git +cd python-deadlines +``` + +3. Install dependencies: + +```bash +bundle install +``` + +4. Start the local server: + +```bash +bundle exec jekyll serve +``` + +## Making Changes + +1. Create a new branch: + +```bash +git checkout -b add-conference-name +``` + +2. Make your changes +3. Test locally +4. Commit with a descriptive message: + +```bash +git commit -m "Add ConferenceName 2024" +``` + +5. Push to your fork: + +```bash +git push origin add-conference-name +``` + +6. Create a Pull Request + +## Pull Request Guidelines + +- Use a clear, descriptive title +- Reference any related issues +- Include screenshots for UI changes +- Update documentation if needed +- Verify all tests pass + +## Using All-Contributors Bot + +We use the All-Contributors bot to recognize all contributors, not just code contributors. Here's how to use it: + +1. Comment on an issue or PR with: + +``` +@all-contributors please add @username for doc,code,content +``` + +Available contribution types: + +- `code`: Code or tests +- `doc`: Documentation +- `content`: Conference data +- `review`: Pull Request reviews +- `bug`: Bug reports +- `ideas`: Ideas and feedback +- `tool`: Tools and utilities + +2. The bot will create a PR to add the contributor +3. Once merged, they'll appear in the README 🎉 + +Example: + +``` +@all-contributors please add @janedoe for content,doc +``` + +## Code Quality + +- Follow PEP 8 for Python code +- Use meaningful variable names +- Add comments for complex logic +- Include docstrings for functions +- Validate YAML files before committing + +## Getting Help + +- Open an issue for questions +- Join discussions in existing issues +- Contact maintainers for guidance + +## Code of Conduct + +Please follow our Code of Conduct in all project interactions. Report violations to the project maintainers. + +## License + +By contributing, you agree that your contributions will be licensed under the MIT License. diff --git a/README.md b/README.md index 3e6a8e49afd..e8fb97151af 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -## Python Deadlines [![pages-build-deployment](https://github.com/JesperDramsch/python-deadlines/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages)](https://github.com/JesperDramsch/python-deadlines/actions/workflows/pages/pages-build-deployment) +## Python Deadlines + +[![pages-build-deployment](https://github.com/JesperDramsch/python-deadlines/actions/workflows/pages/pages-build-deployment/badge.svg?branch=gh-pages)](https://github.com/JesperDramsch/python-deadlines/actions/workflows/pages/pages-build-deployment) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/jesperdramsch/python-deadlines) [![All Contributors](https://img.shields.io/github/all-contributors/jesperdramsch/python-deadlines?color=ee8449)](#contributors) ![GitHub Repo stars](https://img.shields.io/github/stars/jesperdramsch/python-deadlines) Countdown timers to keep track of a bunch of Python conference deadlines. @@ -117,8 +119,27 @@ I mainly run the `main.py` and `sort_yaml.py` to get new entries and move old en - [es-deadlines (Embedded Systems, Computer Architecture, and Cyber-physical Systems)][9] by @AlexVonB and @k0nze - [2019-2020 International Conferences in AI, CV, DM, NLP and Robotics][10] by @JackieTseng - [ccf-deadlines][11] by @ccfddl -- [netdeadlines.com][12] by @albertgranalcoz +- [networking-deadlines (Computer Networking, Measurement)][12] by @andrewcchu - [ad-deadlines.com][13] by @daniel-bogdoll +- [sec-deadlines.github.io/ (Security and Privacy)][14] by @clementfung +- [pythondeadlin.es][15] by @jesperdramsch +- [deadlines.openlifescience.ai (Healthcare domain conferences and workshops)][16] by @monk1337 +- [hci-deadlines.github.io (Human-Computer Interaction conferences)][17] by @makinteract +- [ds-deadlines.github.io (Distributed Systems, Event-based Systems, Performance, and Software Engineering conferences)][18] by @ds-deadlines +- [https://deadlines.cpusec.org/ (Computer Architecture-Security conferences)][19] by @hoseinyavarzadeh +- [se-deadlines.github.io (Software engineering conferences)][20] by @sivanahamer and @imranur-rahman +- [awesome-mlss (Machine Learning Summer Schools)][21] by @sshkhr and @gmberton + +## Contributors + + + + + + + + + ## License @@ -138,5 +159,13 @@ It uses: [9]: https://ekut-es.github.io/es-deadlines/ [10]: https://jackietseng.github.io/conference_call_for_paper/conferences.html [11]: https://ccfddl.github.io/ -[12]: https://netdeadlines.com/ +[12]: https://noise-lab.net/networking-deadlines/ [13]: https://ad-deadlines.com/ +[14]: https://sec-deadlines.github.io/ +[15]: https://pythondeadlin.es/ +[16]: https://deadlines.openlifescience.ai/ +[17]: https://hci-deadlines.github.io/ +[18]: https://ds-deadlines.github.io +[19]: https://deadlines.cpusec.org/ +[20]: https://se-deadlines.github.io/ +[21]: https://awesome-mlss.com/