Skip to content
This repository has been archived by the owner on Sep 16, 2021. It is now read-only.

Contribution Guide #3

Open
NoahAndrews opened this issue Oct 25, 2017 · 7 comments
Open

Contribution Guide #3

NoahAndrews opened this issue Oct 25, 2017 · 7 comments
Assignees
Milestone

Comments

@NoahAndrews
Copy link
Member

NoahAndrews commented Oct 25, 2017

  • Pull requests must be made from a dedicated branch. Do not submit a pull request for your forked master branch.
  • Specify clear rules about where code should be added
  • If you're submitting an enhancement, submit your PR to the OpenFTC-app repository
  • Only submit pull requests to the OpenFTC-app-turbo repository if you're trying to shave more space off or are fixing a bug specific to that version.
  • Any of FIRST's code which you have commented out, modified, or removed should be noted with
    // Modified for OpenFTC or // Modified for turbo, as appropriate
@Windwoes
Copy link
Member

Windwoes commented Oct 25, 2017

Any of FIRST's code which you have commented out, modified, or removed should be noted with //modified for Turbo

@NoahAndrews
Copy link
Member Author

Updated original comment, including that change. Thanks.

@WardBenjamin
Copy link
Contributor

Just as a note, following standard Java and Android comment conventions, that should be:

// Modified for OpenFTC

or

// Modified for Turbo

with a leading space and capitalized first letter.

@NoahAndrews
Copy link
Member Author

Good point.

@NoahAndrews NoahAndrews self-assigned this Oct 31, 2017
@NoahAndrews
Copy link
Member Author

Any code that would require a dependency on another module should be kept out of the OpenFTC module, and likely placed in the same module as the code it depends on. This is to prevent circular dependencies.

If possible, place new classes in other modules in a org.openftc.robotcore package (for example)

@NoahAndrews NoahAndrews added this to the 1.2 milestone Dec 14, 2017
@NoahAndrews
Copy link
Member Author

image

@NoahAndrews
Copy link
Member Author

You can help by giving yourself the tester role on Discord

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

No branches or pull requests

3 participants