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

Things to do before Kickoff #1

Open
ThadHouse opened this issue Nov 23, 2015 · 0 comments
Open

Things to do before Kickoff #1

ThadHouse opened this issue Nov 23, 2015 · 0 comments
Assignees

Comments

@ThadHouse
Copy link
Contributor

Since this needs to be released before kickoff, and we want this to be considered a released project, there are a few things we need to do.

  1. Fix naming. Most everything is good, however I did notice a few things.
    a. No public fields. Only protected, private and internal fields should be used, which camelCase naming. (This might change. We use m_camelCase in the WPILib, which might be a better choice. I will leave that up to you guys though. Just make sure you use the same one throughout the library.)
    b. Public properties use PascalCase
    c. Class names use PascalCase
    d. Class methods use PascalCase
    e. Generic types are always prefixed with T. In simple cases, the type can just be T.
    f. Interfaces are prefixed with the letter I, and then PascalCase (i.e ISubsystem)
    g. Parameter names are in camelCase
    f. If a parameter has the same name as a class field, they can be the same name. Then when accessing the class field, use the this. qualifier. This is the main reason we use m_camelCase for fields in the WPILib, so we do not have to do this.

Pretty much everything is already there for doing that, but there were a few edge cases that need to be fixed.

  1. Make sure everything has summary documentation. Each summary should be at max 2 sentences, preferably 1. If anything needs more explanation, use the tags.
  2. Make sure everything works correctly. There's already a breaking bug in the EnhancedDigitalInput. It might be a good idea to write some unit tests for this to make sure it works correctly. If you need help on how to do that, just ask. Please use Nunit to do this.
  3. Fix folder structure and namespace to have no spaces.
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

No branches or pull requests

2 participants