rootstrap/tech-guides

Guidelines that document processes and standards followed by our entire organization

Rootstrap Guides

This repository contains several guidelines that document processes and standards followed by our entire organization. We hope they may serve as a recommendation to anyone interested in following our quality standards. Guidelines are based on our own experiences and other companies' best practices. The guidelines exploit Git's advantages with regards to collaborative work, encouraging all of our developers to get actively involved with them.

General

• Code review
• Git Workflow
• Git commits
• Open Source
• Pair Programming
• Opening a Pull Request

Languages

• Ruby
• Swift
• Javascript
• CSS
• Python
• Kotlin

Frameworks/Libraries

• Ruby on Rails
• Angular 1
• Angular 2+
• React
• RSpec
• Django
• Node.Js
• Flutter

Hosting Platforms

• Heroku

If you disagree with a guideline, open an issue on the guides repo rather than debating it within the code review. In the meantime, apply the guideline.

tech-guides's Issues

Add Pipenv as the package manager for Python projects

Add a better title/description to the repository

Contributing guide: Broken link to code of conduct

the link to the code of conduct is broken in the file open-source/rootstrap_contributing_guide.md. It returns a 404.

Actually the link is: https://github.com/rootstrap/{repository}/blob/master/CODE_OF_CONDUCT.md
Should it be this one?: https://opensource.guide/code-of-conduct/ (it is the link that appears on the open-source/readme.md file)

Use of PhantomJS on Ruby Rspec guide

Affected Guide:

• ruby/rspec/tutorial.md#feature-specs

Describe your motive to discuss:

It states the use of PhantomJS but I think this tool has been discontinued on 2018.

Describe the solution you propose

Maybe recommend the use of Chrome/ium in headless mode?

Describe alternatives you've considered

Chrome or FF headless

Additional context

More info:

• https://phantomjs.org/
• https://en.wikipedia.org/wiki/PhantomJS

Follow Github recommended community standards

Check https://github.com/rootstrap/tech-guides/community

Doc - Improve OS standars

Add:

• License
• Logo

let vs. let!

Affected Guide:
https://github.com/rootstrap/tech-guides/blob/master/ruby/rspec/tutorial.md

Describe your motive to discuss:
When learning RSpec for the first time, it may be confusing to understand what the use of ! with let variables is for.

Describe the solution you propose
I think it would be helpful to add an explanation of how to use it and add some examples.

Fix indexes in Python style guide

Some indexes in the python style guide that are not pointing to where they should point