From 4e8c51769e6534b23ee9c140279dd0e97c3de96d Mon Sep 17 00:00:00 2001 From: Marcus Penate Date: Sat, 3 Dec 2022 20:06:37 -0500 Subject: [PATCH] Update 'README.md' --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ada0e90..7c25ba5 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,25 @@ # Advent2022 -Advent of Code for 2022 +Group [Advent of Code](https://adventofcode.com/2022) repository for 2022. Private collection of code solutions from those invited to participate in our small community. ## How to contribute -To contribute to the Advent of Code 2022, please pull master and create a branch with your name. +To contribute to the repository, please create a branch with choice of name/identifier and push all changes to that branch. The master branch is locked. -Recommended folder structure is `{Day}\{Language}\{Part}` +Organize your code however you please (categorization of day, language, part are up to you). Do not push compiled applications or input files. To help prevent this automatically, you can create a `.gitignore` file in the root of your branch with the following template: + +``` +*/** +!*/*.{source_extension} + +``` + +This file will ignore all files first and then whitelist files with your `source_extension` only. For example, c++ coders would replace `{source_extension}` with `cpp`. ## Tips -It is recommended to include small document on how the program works and how to compile & run the program. \ No newline at end of file +* [Join our leaderboard](https://adventofcode.com/2022/leaderboard/private) with the join code `1498937-6440e4da` + +* Modify the readme of your branch to include build and run instructions + +* Once the challenges from Advent of Code become more complicated, consider an explanation document (make sure this document isn't ignored by your `.gitignore` configuration) \ No newline at end of file