Registering an article at coderetreat.org
Fork the Coderetreat git repository, current status:
Create a new file called
YYYY-Author-name.yamlin the corresponding directory:
_data/articles/experiences/as-an-attendee/: the article explains the experience when attending a coderetreat.
_data/articles/experiences/as-a-facilitator/: the article explains the experience when facilitating a coderetreat.
_data/articles/about-the-format/: the article talks about the coderetreat format and it's not related to a particular event. In this case, we also include city and country about the author to show the community around the world!
You can either:
The required fields are:
location.country, make sure you use the full name of the country. Example below:
- United Kingdom
- United States of America
✅ US USA
Run the tests locally before creating the pull request (you must have NodeJS installed on your machine):
cd coderetreat.github.io/ # Change into the repository npm install # Install all dependencies npm test # Verify all events
Submit a pull request from Github. Be sure your PR title is clear.
Travis-CI will automatically verify that your YAML file is valid (it should show up here in the test output)
The Coderetreat coordinators will then merge your request as soon as possible.