diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 332971c0a..0b9f59564 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,21 +31,29 @@ on how to setup the test suite. ### 4. Did you find a bug? -* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/monicahq/monica/issues). +* **Ensure the bug was not already reported** by searching on GitHub under +[Issues](https://github.com/monicahq/monica/issues). -* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/monicahq/monica/issues/new). +* If you're unable to find an open issue addressing the problem, +[open a new one](https://github.com/monicahq/monica/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. ### 5. Implement your fix or feature -At this point, you're ready to make your changes! Feel free to ask for help; +* At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first :smile_cat: - -To write good commit messages, please follow [those recommendations](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). There are important to maintain an healthy commit logs. - -If you wish to appear as a contributor, update the CONTRIBUTORS file and +* Write a good commit message. To write good commit messages, please follow +[those recommendations](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). +There are important to maintain an healthy commit logs. +* If there are multiple commits in your pull request, these commits will be +squashed before merging. Please make sure, if that's the case, that your pull +request has a nice description explaining what it does. +* It's okay to have work-in-progress pull requests. Add `[WIP]` in the title of +your pull request if that's the case, otherwise your pull request will be +considered in a state of being able to be merged as is. +* If you wish to appear as a contributor, update the CONTRIBUTORS file and add your name to it. Include this change in your pull request. ### 6. Wait for the code to be reviewed @@ -55,8 +63,8 @@ all have a lot of work to do and while we truly appreciate pull requests that are submitted, we can't review them instantly. We'll do our best to review them as fast as possible, but there are only 24 hours in a day and we can't sometimes be as fast as we wish we were. Moreover, there are little chances that -the PR will be reviewed over the weekend, a time dedicated to spend time with -friends and families (those you manage with MonicaHQ anyway :-)). +the PR will be reviewed over the weekend, a time dedicated to spend time with +friends and families (those you manage with Monica anyway :-)). ### 7. What can I contribute to? diff --git a/readme.md b/readme.md index af7570ec9..ad8eecef8 100644 --- a/readme.md +++ b/readme.md @@ -38,9 +38,10 @@ ## Introduction -Monica is an open-source web application to manage your personal relationships. -Think of it as a CRM for your friends or family. This is what it currently -looks like: +Monica is an open-source web application to organize the interactions with your +loved ones. Think of it as a [CRM](https://en.wikipedia.org/wiki/Customer_relationship_management) +(a popular tool used in companies) for your friends or family. This is what it +currently looks like: ![screenshot of the application](https://app.monicahq.com/img/screenshot.png) @@ -75,7 +76,7 @@ social interactions. Monica is not a social network and never will be. It's not meant to be social. In fact, it's for your eyes only. Monica is also not a smart assistant - it -won't guess what you want to do. In fact, it's pretty dumb: it will send you +won't guess what you want to do. It's pretty dumb: it will send you emails only for the things you asked to be reminded of. ## Get started @@ -174,9 +175,9 @@ you can pull the repository and start setup Monica. 1. Run `php artisan key:generate` to generate an application key. This will set `APP_KEY` with the right value automatically. 1. `npm install` to install bower and gulp. 1. `bower install` to install front-end dependencies in the `vendor` folder. -1. Create a database called `monica` +1. Create a database called `monica`. 1. `php artisan key:generate` to generate a random APP_KEY -1. `php artisan migrate` to run all migrations +1. `php artisan migrate` to run all migrations. 1. `php artisan storage:link` to access the avatars. 1. `php artisan db:seed --class ActivityTypesTableSeeder` to populate the activity types. @@ -316,17 +317,19 @@ There are several ways to help this project to move forward: * Unlike Fight Club, the best way to help is to actually talk about the project as much as you can. * You can answer questions in the issue tracker to help other community members. -* Look for [issues labelled bugs](https://github.com/monicahq/monica/issues?q=is%3Aopen+is%3Aissue+label%3Abug) - if you are looking to have an immediate impact on the project. -* Look for [issues labelled enhancements](https://github.com/monicahq/monica/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) - These are issues that you can solve relatively easily. - * If you are an advanced developer, you can try to tackle - [issues labelled feature requests](https://github.com/monicahq/monica/issues?q=is%3Aopen+is%3Aissue+label%3A%22feature+request%22). - Beware though - they are harder to do and will require a lot of back and forth - with the repository administrator in order to make sure we are going to the right - direction with the product. -* Finally, and most importantly, we are looking for people willing to write - tests for the existing features. +* If you are a developer: + * Read our [Contribution Guide](/CONTRIBUTING.md). + * Look for [issues labelled bugs](https://github.com/monicahq/monica/issues?q=is%3Aopen+is%3Aissue+label%3Abug) + if you are looking to have an immediate impact on the project. + * Look for [issues labelled enhancements](https://github.com/monicahq/monica/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) + These are issues that you can solve relatively easily. + * If you are an advanced developer, you can try to tackle + [issues labelled feature requests](https://github.com/monicahq/monica/issues?q=is%3Aopen+is%3Aissue+label%3A%22feature+request%22). + Beware though - they are harder to do and will require a lot of back and + forth with the repository administrator in order to make sure we are going + to the right direction with the product. + * Finally, and most importantly, we are looking for people willing to write + tests for the existing features. ## Vision, goals and strategy @@ -461,6 +464,11 @@ users will follow. You can support the development of this tool [on Patreon](https://www.patreon.com/monicahq). Thanks for your help. +## Contact + +If you need to talk, you can contact me at regis AT monicahq DOT com. You can +also reach me [on Twitter](https://twitter.com/djaiss). + ## License Copyright (c) 2016-2017 Regis Freyd