Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 1.95 KB

Contributing Guidelines

First off, thank you for considering contributing to Rails-Setup. It’s people like you that make this project great.

How to

  • Make sure that nobody else is already working on what you want to contribute (check Issues and PRs).
  • Raise an issue explaining what you want in the project and if you are going to take care of it.
  • fork the project and work on a different branch from master.
  • send a pull request

Type of contributions

Misspelling fixes

As humans we are prone to erros, including misspelling. if you see any please rise an issue.

Fix documentation issues

Most of the documentation added is just copied from the original projects, sometimes it comes with links to images and another pages that get broke once you put in here. you can help fixing that kind of things.

Add documentation for common Rails related libraries

You could bring here documentation from another project that usually dont have their own documentation website or maybe their website is not friendly enough.

Enhancing the website

If you have cool ideas to imporve the look and feel of the index or any other page, please raise an issue explaining what do you have in mind.

Roadmap

the idea is to have documentatios by topic and library. like:

  • Rails
  • Authentication
    • devise
    • jwt
    • others libraries...
  • Testing
    • minitest
    • rspec
    • others...
  • Commonly used
    • Faker
    • Factory bot

The ultimate goal is to have all what you need to achieve whatever you want in your rails project. All in one place. all easy to navigate.

Getting in touch

Feel free to get in touch. send me an email, or even better, tweet me @HenryTabimaG