Skip to content

Commit 7eadb89

Browse files
committed
docs(contributing): added CONTRIBUTING.md and updated README
1 parent 334c82d commit 7eadb89

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing
2+
3+
If you wish to contribute to this project, simply fork and the clone the repository, make your changes (on master or a feature branch, up to you), and submit a pull request. Contributions are quite welcome!
4+
5+
## Guidelines
6+
7+
* Keep in mind that using the template is intended to be quite straightforward even without specific .NET experience.
8+
* Please adhere to the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/).
9+
10+
## Wanted Contributions
11+
12+
* **Benchmarking.** Some plug-n-play benchmarking utility would be a great boon to anyone wanting to track the efficiency of their solutions.
13+
* **Example projects.** If you have been using this template yourself, your project might serve as a useful example in the README's "example projects" section.

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Template project for solving Advent of Code in C#, running on [.NET 5.0](https:/
1212
- [Using a Solution's Constructor](#using-a-solutions-constructor)
1313
- [Using .NET Core](#using-net-core)
1414
- [Automatic Debugger Break On Exception](#automatic-debugger-break-on-exception)
15+
- [Background](#background)
1516
- [Contributing](#contributing)
1617
- [License](#license)
1718

@@ -111,8 +112,11 @@ Simply swap out the target framework in `AdventOfCode.csproj`.
111112
### Automatic Debugger Break On Exception
112113
When running your Solutions with a Debugger attached e.g. [VSCode](https://code.visualstudio.com/docs/editor/debugging) or [Visual Studio](https://docs.microsoft.com/en-us/visualstudio/debugger/quickstart-debug-with-managed?view=vs-2019) the ASolution base class will try to pause/break the debugger when there is an uncaught Exception thrown by your solution part. This allows for inspection with the debugger without having to specifically set-up additional exception handling within the debugger or your solution.
113114

115+
## Background
116+
I intended to use Advent of Code 2019 to learn C#, and found that I wanted to try to put together a small solutions framework of my own. In that way this template came about as an introductory project to C# and .NET Core.
117+
114118
## Contributing
115-
Sure! Fork the project, make your changes, and create a pull request. Submitted issues and pull requests are quite welcome.
119+
Sure! Check out the [contributing guide](https://github.com/sindrekjr/AdventOfCodeBase/blob/master/CONTRIBUTING.md).
116120

117121
## License
118122
[MIT](https://github.com/sindrekjr/AdventOfCodeBase/blob/master/LICENSE.md)

0 commit comments

Comments
 (0)