Cachet/CONTRIBUTING.md

# Contribution Guidelines

## Creating issues

We track feature requests and bug reports on the [issue tracker](https://github.com/cachethq/Cachet/issues). Please send support requests to our support email; [support@alt-three.com](mailto:support@alt-three.com?subject=Cachet Support).

**Always be respectful.** Organisation members reserve the right to lock topics if they feel necessary.

## Languages

Please submit non-English translations to the [Cachet CrowdIn](https://translate.cachethq.io) project. This makes syncing translations much easier.

## Coding Standards

Please try to follow existing coding standards. [StyleCI](https://styleci.io) will analyse and fix any discrepancies in coding standards.

## Introduction into Git and GitHub

If you are new to Git, GitHub and the whole open source software community, welcome! Here are some resources for getting started and understanding what it's all about.

- [Try Git](https://try.github.io/levels/1/challenges/1) by Code School
- [GitHub Help](https://help.github.com)

If you're not fond of the command line, you can get one of GitHub's free GUI desktop apps:

- [GitHub for Mac](https://github.com/blog/1510-installing-git-from-github-for-mac)
- [GitHub for Windows](https://github.com/blog/1127-github-for-windows)

If you're feeling adventurous, you can become a Git & GitHub master with the [Git Path on Code School](https://www.codeschool.com/paths/git).

## .editorconfig

You should also make use of the [.editorconfig](/.editorconfig) file found within the root of the repository. It'll make sure that your editor is setup with the same file settings.

---

## Contributing as a non-developer/non-designer

We're always looking for new [translations](#translations).

Of course bug reports, feature requests and [documentation](https://docs.cachethq.io) are always appreciated.

## Contributing as a designer

As Cachet gains new features, the design and ideas that were once a perfect fit need updating and in some cases designing from scratch. This is where you come in! Fancy giving Cachet a lick of paint? Sweet!

You'll need to install Node.js, Bower and Gulp.

To get started you can do the following:

1. Install Node.js and our dev dependencies.
2. Run `gulp`
3. Make your changes to the SCSS files in `./resources/assets/sass/`

If you're making a lot of changes, you'll find that running `gulp watch` will make life easier for you!

When you're happy with your changes, please run `gulp --production` to minify the assets.

## Contributing as a developer

Built using [Laravel](https://laravel.com).

We use these extra dependencies to develop Cachet:

- Node.js
- Gulp
- Git

Once cloned to your local machine, you'll need some demo data! Run `php artisan cachet:seed` to get the demo installation ready for action.
-												First commit, Laravel is setup!

											
										
										
											2014-11-16 22:26:08 +00:00
+								# Contribution Guidelines
-												Update Contributing guidelines.

											
										
										
											2014-11-19 22:20:37 +00:00
+								## Creating issues
-												Write-gooder!

											
										
										
											2017-01-02 14:56:57 +00:00
+								We track feature requests and bug reports on the [issue tracker](https://github.com/cachethq/Cachet/issues). Please send support requests to our support email; [support@alt-three.com](mailto:support@alt-three.com?subject=Cachet Support).
-												Update contributing document

											
										
										
											2014-12-05 12:51:52 +00:00
-												Write-gooder!

											
										
										
											2017-01-02 14:56:57 +00:00
+								**Always be respectful.** Organisation members reserve the right to lock topics if they feel necessary.
-												Update Contributing guidelines.

											
										
										
											2014-11-19 22:20:37 +00:00
-												Write language files, not into the code. Closes #283

											
										
										
											2015-01-06 09:02:15 +00:00
+								## Languages
-												Write-gooder!

											
										
										
											2017-01-02 14:56:57 +00:00
+								Please submit non-English translations to the [Cachet CrowdIn](https://translate.cachethq.io) project. This makes syncing translations much easier.
-												Write language files, not into the code. Closes #283

											
										
										
											2015-01-06 09:02:15 +00:00
-												Update Contributing guidelines.

											
										
										
											2014-11-19 22:20:37 +00:00
+								## Coding Standards
-												Write-gooder!

											
										
										
											2017-01-02 14:56:57 +00:00
+								Please try to follow existing coding standards. [StyleCI](https://styleci.io) will analyse and fix any discrepancies in coding standards.
-												update CONTRIBUTING.md to include an Intro to Git and GitHub section

											
										
										
											2014-11-29 17:58:52 -05:00
-												Fix typo

Into to doesn't seem natural, is it?

											
										
										
											2015-10-06 01:47:43 +09:00
+								## Introduction into Git and GitHub
-												update CONTRIBUTING.md to include an Intro to Git and GitHub section

											
										
										
											2014-11-29 17:58:52 -05:00
-												Closes #355 - Updated contributing document

											
										
										
											2015-01-12 16:07:12 +00:00
+								If you are new to Git, GitHub and the whole open source software community, welcome! Here are some resources for getting started and understanding what it's all about.
-												update CONTRIBUTING.md to include an Intro to Git and GitHub section

											
										
										
											2014-11-29 17:58:52 -05:00
 								- [Try Git](https://try.github.io/levels/1/challenges/1) by Code School
 								- [GitHub Help](https://help.github.com)
-												Write-gooder!

											
										
										
											2017-01-02 14:56:57 +00:00
+								If you're not fond of the command line, you can get one of GitHub's free GUI desktop apps:
-												update CONTRIBUTING.md to include an Intro to Git and GitHub section

											
										
										
											2014-11-29 17:58:52 -05:00
 								- [GitHub for Mac](https://github.com/blog/1510-installing-git-from-github-for-mac)
 								- [GitHub for Windows](https://github.com/blog/1127-github-for-windows)
-												A couple of small text changes
											
										
										
											2014-12-18 09:17:58 +00:00
+								If you're feeling adventurous, you can become a Git & GitHub master with the [Git Path on Code School](https://www.codeschool.com/paths/git).
-												update CONTRIBUTING.md to include an Intro to Git and GitHub section

											
										
										
											2014-11-29 17:58:52 -05:00
-												Update CONTRIBUTING.md
											
										
										
											2015-08-05 08:47:32 +01:00
+								## .editorconfig
-												Include .editorconfig in CONTRIBUTING.md

											
										
										
											2015-01-24 15:16:23 +00:00
 								You should also make use of the [.editorconfig](/.editorconfig) file found within the root of the repository. It'll make sure that your editor is setup with the same file settings.
-												Update README.md and CONTRIBUTING.md files

											
										
										
											2017-01-02 14:52:43 +00:00
 								---
 								## Contributing as a non-developer/non-designer
 								We're always looking for new [translations](#translations).
 								Of course bug reports, feature requests and [documentation](https://docs.cachethq.io) are always appreciated.
 								## Contributing as a designer
 								As Cachet gains new features, the design and ideas that were once a perfect fit need updating and in some cases designing from scratch. This is where you come in! Fancy giving Cachet a lick of paint? Sweet!
 								You'll need to install Node.js, Bower and Gulp.
 								To get started you can do the following:
 . Install Node.js and our dev dependencies.
 . Run `gulp`
 . Make your changes to the SCSS files in `./resources/assets/sass/`
 								If you're making a lot of changes, you'll find that running `gulp watch` will make life easier for you!
 								When you're happy with your changes, please run `gulp --production` to minify the assets.
 								## Contributing as a developer
 								Built using [Laravel](https://laravel.com).
 								We use these extra dependencies to develop Cachet:
 								- Node.js
 								- Gulp
 								- Git
 								Once cloned to your local machine, you'll need some demo data! Run `php artisan cachet:seed` to get the demo installation ready for action.