forked from paperswithcode/ai-deadlines
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
12b1ba5
commit 03a931c
Showing
3 changed files
with
231 additions
and
3 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "projectName": "jesperdramsch", | ||
| "projectOwner": "python-deadlines" | ||
| } |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,195 @@ | ||
| # Contributing to Python Deadlines | ||
|
|
||
| [](https://github.com/JesperDramsch/python-deadlines/actions/workflows/pages/pages-build-deployment)   [](#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. |
This file contains 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