|
| 1 | +Contributiung |
| 2 | +============= |
| 3 | + |
| 4 | +Issues & discussions |
| 5 | +-------------------- |
| 6 | + |
| 7 | +You can open an issue or discussion for virtually anything you want: |
| 8 | + |
| 9 | +- Report typos or other mistakes. |
| 10 | +- Ask me a question. |
| 11 | +- Discuss about an existing or alternative solution. |
| 12 | +- Propose a change or improvement. |
| 13 | + |
| 14 | + |
| 15 | +Pull Requests |
| 16 | +------------- |
| 17 | + |
| 18 | +Please do *not* submit pull requests for: |
| 19 | + |
| 20 | +- Changes to original solutions: I only keep those as a snapshot of the first |
| 21 | + solution I wrote when solving the puzzles. They are not really supposed to be |
| 22 | + changed, and definitely *not* supposed to be clean, optimal or even correct. I |
| 23 | + only update those if I update some of the used utiliy functions just to keep |
| 24 | + them at least runnable. |
| 25 | + |
| 26 | +- Changes to clean solutions and walkthrougs: the choices I make for clean |
| 27 | + solutions are mostly documented in my walkthroughs. If you think that |
| 28 | + something is off, or that some improvement is possible, you are most welcome |
| 29 | + to [open an issue][new-issue] or [start a discussion][new-discussion] to tell |
| 30 | + me about it. I prefer this because (1) it's less work for you, (2) I need to |
| 31 | + understand and adapt the suggestion before even thinking of applying it, (3) |
| 32 | + I will also have to adapt the walkthrough at the same time, and finally (4) I |
| 33 | + might change mind about the license that I am using for my work in the future. |
| 34 | + |
| 35 | +- Grammatical errors, typos, phrasing mistakes in walkthrougs: |
| 36 | + please, [open an issue][new-issue] instead. I update the repository |
| 37 | + walkthrougs constantly, and keep track of things that need to get fixed in a |
| 38 | + private list. Therefore, there is a high chance that I already spotted the |
| 39 | + problem by myself, and since I try to keep "fix typo" commits to a minimum, I |
| 40 | + am just waiting to do a single commit with a batch of fixes. |
| 41 | + |
| 42 | +Feel free to open pull requests for: |
| 43 | + |
| 44 | +- Adding new solutions derived from mine: different approaches, alternative |
| 45 | + solutions using interesting external libraries, etc. If you do, put those |
| 46 | + under an appropriate folder: `YEAR/misc/dayXX/` and use meaningful file names. |
| 47 | + |
| 48 | +- Editing/fixing/improving anything under the `YEAR/misc/` folders that is not a |
| 49 | + solution: scripts for visualizations, the script used to fetch leaderboards, |
| 50 | + etc. |
| 51 | + |
| 52 | +- Editing/fixing/improving anything outside the different year's folders: |
| 53 | + utilities, documentation (including this document), and so on. |
| 54 | + |
| 55 | +[new-issue]: https://github.com/mebeim/aoc/issues/new |
| 56 | +[new-discussion]: https://github.com/mebeim/aoc/discussions |
0 commit comments