Skip to content

Adding a Chapter

Athanasia Monika Mowinckel edited this page Oct 4, 2023 · 4 revisions

Create a new file

Create a new file in the data/chapters/ folder by using this link. This link will fork the repository to your user account, and initiate a new file with some template content in it.

File name

The name of the file should be the chapters identifier, with country (state/region if applicable) and city. This way we can ensure each file has a unique name and that duplication does not happen. Any spaces should be substituted with a dash (-).

File content

Fill in the appropriate information in the json. Make sure to remove everything after the double slashes (//) in the final file, as these are just comments to help you fill out the information properly. If the chapter does not have a state/region to apply, the entire line may be removed (rather than left empty).

example file:

[
  {
    "urlname": "rladies-Algiers",
    "status": "prospective",
    "country": "Algeria",
    "city": "Algiers",
    "social_media": {
      "meetup": "rladies-Algiers",
      "email": "[email protected]"
    },
    "organizers": {
      "current": ["Kamila Benadrouche", "Lounas Fairouz", "Zibani Fazia"],
      "former": []
    }
  }
]

Social media options

There are a set of currently available social media to be added. If you think a new social media outlet should be added to the list, contact a website maintainer.

"twitter": "username"
"github": "username"
"instagram": "username"
"youtube": "username/end-url"
"tiktok": "username"
"periscope": "username"
"researchgate": "username"
"website": "url"
"linkedin": "username"
"facebook": "username"
"orcid": "member number"
"meetup": "end-url"
"mastodon": "@username@server"

Commit and PR the file

At the bottom of the page on GitHub, add a commit message in the box.

You will immediately be sent to the 'Pull requests' page, to create a PR to the main branch. Click the Create pull request button. Once this is done, a new page will open and some automated checks of your submitted entries start. In the comment section, make sure to @drmowinckels so she can take a look.

If anything needs fixing you will be notified and given instructions on how to do that.

Once all checks pass and the entries have been reviewed, they will be merged to the main branch.