CONTRIBUTING.md

Conference Data Contributing Guidelines

Getting Started

1. Fork the repository on GitHub.

2. Clone the forked repository to your local machine.

   git clone https://github.com/<your_github_username>/conference-data.git

3. Get into the root directory

   cd conference-data

4. Install all the dependencies

   npm install

5. Create your branch

   git checkout -b <your_branch_name>

6. Run the development server

   npm run dev

Making Changes

1. Make sure your code follows the style guidelines of this project.

2. If you are adding a conference, ensure that you are following the Conference data structure mentioned below:

   {
       "name": "",
       "url": "",
       "startDate": "YYYY-MM-DD",
       "endDate": "YYYY-MM-DD",
       "city": "",
       "country": "",
       "cfpUrl": "",
       "cfpEndDate": "",
       "twitter": "",
       "mastodon": "",
       "cocUrl": "",
       "locales": ""
   }

3. Save your changes and run the tests.

   npm run test

4. Write clear, concise commit messages. Linking the commit to an issue is also a good practice to follow.

   git commit -m "✨ Fixes #123: Added <ConferenceName> to the list"

5. Push to the branch.

   git push origin <your_branch_name>

6. Open a pull request.

Code of Conduct

Please note that this project is released with a Code of Conduct. By participating in this project you agree to abide by its terms.