jmanuel1 / code-jam-f-sharp

Solutions to some Code Jam problems in F#.

Hello there 👋

I'm a software developer at Imagine Learning and a recent graduate of Arizona State University. I studied computer science and was an officer of the Software Developers Association. I like using code to create, and I believe in technology's ability to help us do good things. Outside of coding, I like games such as Thomas Was Alone and Cities: Skylines, occasionally taking photos, math, and outer space.

• 🔭 I’m currently working on a transpiled concatenative language called Concat. Check out my Mailspring plugin, Todoer, too.
• 🌱 I’m currently learning programming language design & implementation (at least, what I need to know for Concat).
• 👯 If you want to contribute to any of my projects, I encourage you to look at Concat and Todoer.
• 🤔 I’m looking for help with Concat's type checker and exploring computational sustainability.
• 💬 Ask me about web development, programming languages, computational sustainability, Doctor Who lore, and my favorite Snarky Puppy tracks.
• 📫 How to reach me:
  • LinkedIn
  • Website
• ⚡ Fun fact: Once upon a time, I was on an ultimate frisbee team.

code-jam-f-sharp's Issues

Add project road map

Add tests for 'Rank and File' solution

Add development/build instructions to contribution guidelines

Show version when running CodeJam version/--version/-V/-v

https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46 (3.)

Make errors more informative

https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46 (5.)

Specifically,

1. Error code
2. Error title
3. Error description (Optional)
4. How to fix the error
5. URL for more information

Show help when using CodeJam [--help/help/-h]

https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46 (1.)

Add two more CodeJam solutions

• 2016 1A: The Last Word
• 2016 Qualification: Coin Jam

With tests to verify each solution.

Add README

Write up contribution guidelines and a code of conduct

https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46 (10.)

Add output examples to usage instructions in README

Link to contributing guidelines in README

Add GIF/terminal recording to README

Automate builds, release process, linting, testing

• Add a code linter to enforce the F# code style
• Tools to enforce/monitor the prose style guidelines
• Automate the build process with some CI system that supports MSTest
• Try automating the release process

Example: DocToc uses Travis CI

Currently, no tools like this are being used. I want to use these tools to make the development process less error-prone and to spend more time writing actual code.

The enhancement would be useful because it would codify various development processes and guidelines that I want to use.

Redesign Input module and solution interface

Separate the concerns more and make them more testable.

Add style guide

Include a style guide for F# code. Perhaps, include a style guide for prose too.

An example F# style guide: https://docs.microsoft.com/en-us/dotnet/fsharp/style-guide/

An example prose style guide: https://plainlanguage.gov/guidelines/

Currently, there is no style guide being followed (except for Visual F#'s suggestions). There should be an F# style guide to follow and prose guidelines to follow. This will help make the code easier to read, better designed, and more maintainable. A prose guide will help improve documentation making it clear and easier to read.

These enhancements would be useful in maintaining the consistency of code and prose.

Add system tests

Test end-user-facing behavior, like:

• Displaying a usage message in stdout when there are no arguments/invalid arguments
• Sending error messages to stderr when there no arguments/invalid arguments
• Running a solution denoted with the arguments --problem <name>
• Exit with zero upon success
• Exit with 1 when there are no or invalid arguments