praveen-symphony / beeva-best-practices

Best Practices and Style Guides in BEEVA

#Best Practices in BEEVA

Here is the list of best practices, guidelines, codestyles and recommendations that we follow and encourage in BEEVA, please read the contrib guidelines before sending your pull request with your content.

If you think any information is wrong or missing please write us an email or directly create an issue inside this repo.

Agile

• Kanban
• User Stories
• Working Agreements

Backend

• Java
• Microservices
• Node.js
• Python
• REST Services
• Scala

Big Data

• Best practices for Hadoop
• Hadoop Development & Best Practices
• Hadoop Management Hardware and OS
• Hadoop Management
• Spark Best Practices
• Amazon Redshift Best Practices

Cloud Computing

• Amazon Web Services

DevOps

• Configuration Management
• Docker
• Infrastructure Management
• Git

Frontend

• Angular.js
• HTML5
• Javascript
• CSS & Styling
• Frontend Tool Ecosystem
• Polymer

IT Security & Hardening

• Server Security
• Secure Development

Quality Assurance

• ATDD Acceptance Test-driven Development
• Calabash
• Code Design
• Code Optimization
• Testing techniques
• TDD, BDD and Acceptance Test
• TDD Test-driven Development

Contrib Guidelines

• To contrib using issues and pull requests. For instance if you want to contrib to the documents of Calabash and Server Security you first should check if there is an issue about those subjects, if there isn't you should create 2 separate issues, and explain on the body of the issue what contributions you want to make, the whole idea behind this is that if another employee wants to contribute to the same document you both don't duplicate content, so the issues will be the communication method between the committers. Once you agree on how you will contribute either (alone or with your colleagues) you can create a fork from the repo, you and other committers of the same document/subject have to use the same forked repository so you need to agree who will be the "fork" responsible (and of course grant write permissions between yourself in the fork).
• Once all your contributions are finished in your fork, you should send a Pull Request petition so the integrators can review it and merge it into the main repository of best practices.
• Here is the markdown cheatsheet you can use to create your documents.
• Write in english please :), don't worry if everything is not perfect as we will continue improving this guidelines overtime as we find and implement new best practices.
• Add attributions and references if necessary to external sites, it's nice when your work is recognized by others.
• Please add the images that you required to this repo in the static subfolder of each subsection, in this way we ensure no broken links will be ever created, avoid using external image links.

---

Licence

Please see LICENSE.

BEEVA | 2016