Skip to content

Commit

Permalink
[add] license contributing readme
Browse files Browse the repository at this point in the history
  • Loading branch information
HenryTabima committed Jun 29, 2019
1 parent 07f2665 commit 1a3dd42
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 4 deletions.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# 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](#misspelling-fixes)
* [Fix documentation issues](#fix-documentation-issues)
* [Add documentation for common Rails related libraries](#add-documentation-for-common-rails-related-libraries)

### 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.

## 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.
4 changes: 2 additions & 2 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 Rails-Setup
Copyright (c) 2019-present, Henry Tabima Giraldo

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
# Rails Setup
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors)

[Visit website](https://HenryTabima.github.io/rails-setup)
[Visit Rails-Setup website](https://HenryTabima.github.io/rails-setup)

this is a Project to collect in one place and in a friendly way the documentation for rails and commonly used related libraries

## Getting started

this site is build on top of docusaurus, [see respective documentation](https://docusaurus.io/docs/en/next/installation) to getting started with this project.

## Contributing

We appreciate any contribution you would like to do. To know what you can do the steps to do it, please follow the [contribution guidelines](CONTRIBUTING.md).

Summary:
* 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

## Todos

List of posibles contributions that you can do to this project
Expand All @@ -21,4 +32,7 @@ This project is under [MIT license](LICENSE.md)

## Contributors

* [Henry Tabima giraldo](https://github.com/HenryTabima)
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
* [Henry Tabima giraldo](https://github.com/HenryTabima) (Mantainer)

0 comments on commit 1a3dd42

Please sign in to comment.