mozilla / seasponge

:pineapple: SeaSponge is an accessible threat modelling tool from Mozilla
http://mozilla.github.io/seasponge/
Mozilla Public License 2.0
275 stars 63 forks source link

Discussion: Contributing and Coding Conventions #6

Closed Glavin001 closed 9 years ago

Glavin001 commented 10 years ago

@kallada what do you think about this Pull Request workflow (ref #5)? I think we should lay down the law for contributing and coding conventions. Potentially use coffeelint and define a CoffeeScript coding convention based off of Mozilla's JavaScript style guide.

What are everyone's thoughts? Let's start an open discussion here.

Glavin001 commented 10 years ago

See https://github.com/johnpapa/angularjs-styleguide

Frozenfire92 commented 10 years ago

For git I like Fork -> Feature Branch -> Pull Request -> Comment, Reiterate -> Merge

https://github.com/johnpapa/angularjs-styleguide

This is nicely done, having never used Angular I would be ok in following this.

Glavin001 commented 9 years ago

I agree with the above workflow, with the exception of the initial fork step for us internal maintainers. We can collaborate on feature branches on this repository without forking. For others who do not have write permissions to this repository should fork and submit pull requests.


We should define our coffeelint configuration so we can set our coding style standards up front. Let's discuss this at our weekly meeting this Wednesday.

Glavin001 commented 9 years ago

Here is a CoffeeScript style guide: https://github.com/polarmobile/coffeescript-style-guide