Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Application Style #34

Closed
wants to merge 13 commits into from
Closed

Conversation

FuzzicalLogic
Copy link
Contributor

This makes a number of organizational changes, but not functional. It also establishes our own conformance to the conventions that we have currently set. The need for this PR is to begin the framework to allow for mocking and testing into the CI/CD workflow. The ultimate goal, of course, is automation. In the meantime, we can run tests manually on the local machine.

This also includes tools to allow contributors to conform to our coding standards and practices.

  • STYLE_GUIDE.md - details the code conventions we follow
  • CONTRIBUTING.md - currently a placeholder, but will give requirements for PRs to be accepted and perhaps some guidance on good issues for starting contributors
  • .editorconfig - Configuration file that is used with a variety of IDE and Code Editors. Allows our project to override user and workspace settings for the purpose of conforming to the conventions of our code.

Original source files used 4 spaces. The project's maintainer requested tabs.
This allows multiple projects, most importantly a Test Project
... because VS misbehaves if multiple projects are in the same root, but their files are in subdirectories
Using Xunit for C#
This will allow contributors to know when they are violating our style guidelines.

It also allows contributors to conform without having to change their own editor's configuration as it serves as a project level config.

see [http://editorconfig.org/]
@FuzzicalLogic
Copy link
Contributor Author

Just to be clear, there are currently no tests, just the basest framework.

@FuzzicalLogic
Copy link
Contributor Author

FuzzicalLogic commented May 20, 2019

From here on out, all PRs will be specific and squashed, creating a compact linear history. It would be ideal to know our versioning strategy, but I can understand if that must wait until full modularization.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant