Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 1.93 KB

README.md

File metadata and controls

28 lines (22 loc) · 1.93 KB

Open Source Recommendations

Rootstrap enjoys being a part of the open source community and considers that open source is good for everyone. By embracing open source, it enables collaboration for solving specific problems and helps in reducing bugs.

This is a guide for publishing and maintaining open source projects, check the Github guidelines for Open Source:

Make sure to have:

  • License (default: MIT)
  • Code of Conduct (default: Contributor Covenant)
  • Contributing: We follow the Rootstrap Contributing Guide
  • Continuous Integration (default: Github Actions)
  • Code Quality tools (default: CodeClimate)
  • Readme with: Description, Prerequisites/Installation, Usage, Company credits and links to items above (template: README example)
  • Follow semver for good versioning. Start with version 0.1 and once it has been successfully used in at least one project upgrade to 1.0. Generate a new git tag when releasing a new version.
  • For libs use the master branch not the develop branch as we'd normally do with apps.
  • Add https://rootstrap.com as the repo website and remove unused tabs and sections

The items listed below are nice to have for the repository but aren't mandatory:

  • Add Changelog
  • Blocked main branch for force push

For ruby specific details check developing Gems