Skip to content

Commit 03a931c

Browse files
JesperDramschJesperDramsch
committed
docs: add all-contributors
1 parent 12b1ba5 commit 03a931c

File tree

3 files changed

+231
-3
lines changed

3 files changed

+231
-3
lines changed

‎.all-contributorsrc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"projectName": "jesperdramsch",
3+
"projectOwner": "python-deadlines"
4+
}

‎CONTRIBUTING.md‎

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
# Contributing to Python Deadlines
2+
3+
[![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)
4+
5+
Thank you for your interest in contributing to Python Deadlines! This guide will help you get started with making contributions to the project.
6+
7+
## Table of Contents
8+
9+
- [Contributing to Python Deadlines](#contributing-to-python-deadlines)
10+
- [Table of Contents](#table-of-contents)
11+
- [Ways to Contribute](#ways-to-contribute)
12+
- [Adding or Updating Conference Information](#adding-or-updating-conference-information)
13+
- [Optional Fields](#optional-fields)
14+
- [Development Setup](#development-setup)
15+
- [Making Changes](#making-changes)
16+
- [Pull Request Guidelines](#pull-request-guidelines)
17+
- [Using All-Contributors Bot](#using-all-contributors-bot)
18+
- [Code Quality](#code-quality)
19+
- [Getting Help](#getting-help)
20+
- [Code of Conduct](#code-of-conduct)
21+
- [License](#license)
22+
23+
## Ways to Contribute
24+
25+
You can contribute in several ways:
26+
27+
- Adding or updating conference information
28+
- Improving documentation
29+
- Fixing bugs
30+
- Adding new features
31+
- Reviewing pull requests
32+
33+
## Adding or Updating Conference Information
34+
35+
1. Fork the repository
36+
2. Edit `_data/conferences.yml`
37+
3. Follow this format for conference entries:
38+
39+
```yaml
40+
- conference: BestConf # Title of conference
41+
year: 2024 # Year
42+
link: https://example.com # Conference website URL
43+
cfp: '2024-06-01 23:59:59' # Submission deadline
44+
place: Berlin, Germany # Location
45+
start: 2024-09-15 # Conference start date
46+
end: 2024-09-18 # Conference end date
47+
sub: PY # Conference type (see below)
48+
```
49+
50+
Required fields:
51+
52+
- `conference`: Conference name
53+
- `year`: Conference year
54+
- `link`: Conference website URL
55+
- `cfp`: Call for Proposals deadline
56+
- `place`: Location
57+
- `start`: Conference start date
58+
- `end`: Conference end date
59+
- `sub`: Conference type
60+
61+
Conference types (`sub`):
62+
63+
- `PY`: General Python
64+
- `SCIPY`: Scientific Python
65+
- `DATA`: Python for Data
66+
- `WEB`: Python for Web
67+
- `BIZ`: Python for Business
68+
- `GEO`: Python for Earth
69+
70+
### Optional Fields
71+
72+
You can enhance your entry with these optional fields:
73+
74+
- `alt_name`: Alternative conference name
75+
- `cfp_link`: Specific CFP page URL
76+
- `cfp_ext`: Extended deadline
77+
- `workshop_deadline`: Workshop submission deadline
78+
- `tutorial_deadline`: Tutorial submission deadline
79+
- `timezone`: IANA timezone (defaults to AoE if omitted)
80+
- `sponsor`: Sponsorship page URL
81+
- `finaid`: Financial aid information URL
82+
- `twitter`: Conference Twitter handle
83+
- `mastodon`: Conference Mastodon URL
84+
- `note`: Additional important information
85+
- `location`: Venue coordinates for the map
86+
87+
## Development Setup
88+
89+
1. Install Jekyll (requires Ruby):
90+
91+
```bash
92+
gem install bundler jekyll
93+
```
94+
95+
2. Clone your fork:
96+
97+
```bash
98+
git clone https://github.com/YOUR-USERNAME/python-deadlines.git
99+
cd python-deadlines
100+
```
101+
102+
3. Install dependencies:
103+
104+
```bash
105+
bundle install
106+
```
107+
108+
4. Start the local server:
109+
110+
```bash
111+
bundle exec jekyll serve
112+
```
113+
114+
## Making Changes
115+
116+
1. Create a new branch:
117+
118+
```bash
119+
git checkout -b add-conference-name
120+
```
121+
122+
2. Make your changes
123+
3. Test locally
124+
4. Commit with a descriptive message:
125+
126+
```bash
127+
git commit -m "Add ConferenceName 2024"
128+
```
129+
130+
5. Push to your fork:
131+
132+
```bash
133+
git push origin add-conference-name
134+
```
135+
136+
6. Create a Pull Request
137+
138+
## Pull Request Guidelines
139+
140+
- Use a clear, descriptive title
141+
- Reference any related issues
142+
- Include screenshots for UI changes
143+
- Update documentation if needed
144+
- Verify all tests pass
145+
146+
## Using All-Contributors Bot
147+
148+
We use the All-Contributors bot to recognize all contributors, not just code contributors. Here's how to use it:
149+
150+
1. Comment on an issue or PR with:
151+
152+
```
153+
@all-contributors please add @username for doc,code,content
154+
```
155+
156+
Available contribution types:
157+
158+
- `code`: Code or tests
159+
- `doc`: Documentation
160+
- `content`: Conference data
161+
- `review`: Pull Request reviews
162+
- `bug`: Bug reports
163+
- `ideas`: Ideas and feedback
164+
- `tool`: Tools and utilities
165+
166+
2. The bot will create a PR to add the contributor
167+
3. Once merged, they'll appear in the README 🎉
168+
169+
Example:
170+
171+
```
172+
@all-contributors please add @janedoe for content,doc
173+
```
174+
175+
## Code Quality
176+
177+
- Follow PEP 8 for Python code
178+
- Use meaningful variable names
179+
- Add comments for complex logic
180+
- Include docstrings for functions
181+
- Validate YAML files before committing
182+
183+
## Getting Help
184+
185+
- Open an issue for questions
186+
- Join discussions in existing issues
187+
- Contact maintainers for guidance
188+
189+
## Code of Conduct
190+
191+
Please follow our Code of Conduct in all project interactions. Report violations to the project maintainers.
192+
193+
## License
194+
195+
By contributing, you agree that your contributions will be licensed under the MIT License.

‎README.md‎

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
## 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)
1+
## Python Deadlines
2+
3+
[![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)
24

35
Countdown timers to keep track of a bunch of Python conference deadlines.
46

@@ -117,8 +119,27 @@ I mainly run the `main.py` and `sort_yaml.py` to get new entries and move old en
117119
- [es-deadlines (Embedded Systems, Computer Architecture, and Cyber-physical Systems)][9] by @AlexVonB and @k0nze
118120
- [2019-2020 International Conferences in AI, CV, DM, NLP and Robotics][10] by @JackieTseng
119121
- [ccf-deadlines][11] by @ccfddl
120-
- [netdeadlines.com][12] by @albertgranalcoz
122+
- [networking-deadlines (Computer Networking, Measurement)][12] by @andrewcchu
121123
- [ad-deadlines.com][13] by @daniel-bogdoll
124+
- [sec-deadlines.github.io/ (Security and Privacy)][14] by @clementfung
125+
- [pythondeadlin.es][15] by @jesperdramsch
126+
- [deadlines.openlifescience.ai (Healthcare domain conferences and workshops)][16] by @monk1337
127+
- [hci-deadlines.github.io (Human-Computer Interaction conferences)][17] by @makinteract
128+
- [ds-deadlines.github.io (Distributed Systems, Event-based Systems, Performance, and Software Engineering conferences)][18] by @ds-deadlines
129+
- [https://deadlines.cpusec.org/ (Computer Architecture-Security conferences)][19] by @hoseinyavarzadeh
130+
- [se-deadlines.github.io (Software engineering conferences)][20] by @sivanahamer and @imranur-rahman
131+
- [awesome-mlss (Machine Learning Summer Schools)][21] by @sshkhr and @gmberton
132+
133+
## Contributors
134+
135+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
136+
<!-- prettier-ignore-start -->
137+
<!-- markdownlint-disable -->
138+
139+
<!-- markdownlint-restore -->
140+
<!-- prettier-ignore-end -->
141+
142+
<!-- ALL-CONTRIBUTORS-LIST:END -->
122143

123144
## License
124145

@@ -138,5 +159,13 @@ It uses:
138159
[9]: https://ekut-es.github.io/es-deadlines/
139160
[10]: https://jackietseng.github.io/conference_call_for_paper/conferences.html
140161
[11]: https://ccfddl.github.io/
141-
[12]: https://netdeadlines.com/
162+
[12]: https://noise-lab.net/networking-deadlines/
142163
[13]: https://ad-deadlines.com/
164+
[14]: https://sec-deadlines.github.io/
165+
[15]: https://pythondeadlin.es/
166+
[16]: https://deadlines.openlifescience.ai/
167+
[17]: https://hci-deadlines.github.io/
168+
[18]: https://ds-deadlines.github.io
169+
[19]: https://deadlines.cpusec.org/
170+
[20]: https://se-deadlines.github.io/
171+
[21]: https://awesome-mlss.com/

0 commit comments

Comments
 (0)