Technical/Update git docs (#10)

* Updated pull request template * Updated contributing * Updated changelog * Added branch naming convention
truemail-rb · Nov 12, 2020 · 1ec3a4b · 1ec3a4b
1 parent 65461ed
commit 1ec3a4b
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 17 deletions.
diff --git a/.github/BRANCH_NAMING_CONVENTION.md b/.github/BRANCH_NAMING_CONVENTION.md
@@ -0,0 +1,36 @@
+# Branch naming convention
+
+## Branch naming
+
+> Please note for new pull requests create new branches from current `develop` branch only.
+
+Branch name should include type of your contribution and context. Please follow next pattern for naming your branches:
+
+```bash
+feature/add-some-feature
+technical/some-technical-improvements
+bugfix/fix-some-bug-name
+```
+
+## Before PR actions
+
+### Squash commits
+
+Please squash all branch commits into the one before openning your PR from your fork. It's simple to do with the git:
+
+```bash
+git rebase -i [hash your first commit of your branch]~1
+git rebase -i 6467fe36232401fa740af067cfd8ac9ec932fed2~1 # example
+```
+
+### Add commit description
+
+Please complete your commit description folowing next pattern:
+
+```
+Technical/Add info files # should be the same name as your branch name
+
+* Added license, changelog, contributing, code of conduct docs
+* Added GitHub templates
+* Updated project license link
+```
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,6 +1,9 @@
 # PR Details
 
 <!-- Provide a general summary of your changes in the Title above -->
+<!-- PR name should the same name as your branch name, example: -->
+<!-- Branch name is: feature/add-some-feature -->
+<!-- PR name should be: Feature/Add some feature -->
 
 ## Description
 
@@ -42,5 +45,3 @@
 - [ ] I have updated the documentation accordingly
 - [ ] I have read the [**CONTRIBUTING** document](../CONTRIBUTING.md)
 - [ ] I have added tests to cover my changes
-- [ ] I have run `bundle exec rspec` from the root directory to see all new and existing tests pass
-- [ ] I have run `rubocop` and `reek` to ensure the code style is valid
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] - 2020-10-**
+## [0.1.0] - 2020-11-06
 
 ### First release
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -8,7 +8,6 @@ Following these guidelines helps to communicate that you respect the time of the
 
 The issue tracker is the preferred channel for [bug reports](#bugs), [features requests](#features) and [submitting pull requests](#pull-requests).
 
-<a name="bugs"></a>
 ## Bug/issue reports
 
 A bug is a _demonstrable problem_ that is caused by the code in the repository.
@@ -17,17 +16,15 @@ Good bug reports are extremely helpful - thank you!
 Guidelines for bug reports:
 
 1. **Use the GitHub issue search** &mdash; check if the issue has already been reported
-2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest `master` or development branch in the repository
+2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest `master` or `develop` branch in the repository
 3. Truemail [issue template](.github/ISSUE_TEMPLATE.md)
 
 A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
 
-<a name="features"></a>
 ## Feature requests
 
 Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
 
-<a name="pull-requests"></a>
 ## Pull requests
 
 Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
@@ -39,7 +36,8 @@ Please adhere to the coding conventions used throughout a project (indentation,
 Guidelines for pull requests:
 
 1. Truemail [pull request template](.github/PULL_REQUEST_TEMPLATE.md)
-2. Fork the repo
+2. Fork the repo, checkout to `develop` branch
 3. Run the tests. This is to make sure your starting point works
-4. Create a new branch and make your changes. This includes tests for features!
-5. Push to your fork and submit a pull request
+4. Read our [branch naming convention](.github/BRANCH_NAMING_CONVENTION.md)
+5. Create a new branch and make your changes. This includes tests for features!
+6. Push to your fork and submit a pull request to `develop` branch
diff --git a/LICENSE → LICENSE.txt b/LICENSE → LICENSE.txt
diff --git a/README.md b/README.md
@@ -1,8 +1,12 @@
 # ![Truemail web API client library for Java](https://truemail-rb.org/assets/images/truemail_logo.png)
 
-![GitHub release (latest by date)](https://img.shields.io/github/v/release/truemail-rb/truemail-java-client) [![CircleCI](https://circleci.com/gh/truemail-rb/truemail-java-client/tree/develop.svg?style=svg)](https://circleci.com/gh/truemail-rb/truemail-java-client/tree/develop) [![Gitter](https://badges.gitter.im/truemail-rb/community.svg)](https://gitter.im/truemail-rb/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+[![CircleCI](https://circleci.com/gh/truemail-rb/truemail-java-client/tree/develop.svg?style=svg)](https://circleci.com/gh/truemail-rb/truemail-java-client/tree/develop)
+[![Maven Central](https://img.shields.io/maven-central/v/org.truemail-rb/truemail-java-client.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.truemail-rb%22%20AND%20a:%22truemail-java-client%22)
+[![GitHub](https://img.shields.io/github/license/truemail-rb/truemail-java-client)](LICENSE.txt)
+[![Gitter](https://badges.gitter.im/truemail-rb/community.svg)](https://gitter.im/truemail-rb/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
 
-`truemail-java-client` - Truemail web API client library for Java.
+`truemail-java-client` - Web API Java client for Truemail Server.
 
 > Actual and maintainable documentation :books: for developers is living [here](https://truemail-rb.org/truemail-java-client).
 
@@ -30,22 +34,36 @@ Java 1.8+
 
 ## Installation
 
-All available versions you can find [here](https://github.com/truemail-rb/truemail-java-client/releases).
+> Please change {version} to needed version, for example 0.1.0. All available versions you can find [here](https://github.com/truemail-rb/truemail-java-client/releases).
 
-### Maven
+### Apache Maven
 
 ```xml
 <dependency>
   <groupId>org.truemail-rb</groupId>
   <artifactId>truemail-java-client</artifactId>
-  <version>${version}</version>
+  <version>{version}</version>
 </dependency>
 ```
 
-### Gradle
+### Gradle Groovy
 
 ```groovy
-compile group: 'org.truemail-rb', name: 'truemail-java-client', version: 'version'
+implementation 'org.truemail-rb:truemail-java-client:{version}'
+```
+
+### Apache Ivy
+
+```xml
+<dependency org="org.truemail-rb" name="truemail-java-client" rev="{version}" />
+```
+
+### Groovy Grape
+
+```groovy
+@Grapes(
+  @Grab(group='org.truemail-rb', module='truemail-java-client', version='{version}')
+)
 ```
 
 ## Usage