Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add description of conventional commits #178

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Changelog

## v0.0.9 (2020-03-16)

#### Fixes

* fixed help command in Makefile

## v0.0.8 (2019-10-26)


## v0.0.7 (2019-05-26)

#### Fixes

* flake typo
* ignore B607 issue for subprocess
* ignore B607 issue for subprocess
* ignore B607 issue for subprocess
* Fixed bandit and flake8 errors in
* Fixed typos connected with update packages command
* Fixed problem connected with a if statement

## v0.0.6 (2019-03-06)

#### Docs

* renamed a documentation file

## v0.0.5 (2018-12-25)


## v0.0.4 (2018-12-25)


## v0.0.3 (2018-10-30)

#### New Features

* added descriptions to `pypi` and fixed some typos
* added cookiecutter command line
* start move to cookiecutter
* start move to cookiecutter
* updated version
* added db test and added coverage for py.test
* move test to docker
* added alembic
* added postgres to docker
* added production settings for docker
* added mypy
* added docs
* added jinja
* corrected structure
* added `.gitignore` file
* corrected styles of the main page
* added the initial page
* added `aiohttp-devtools`
* create a simple aiohttp template
* initial commit
#### Fixes

* corrected path to template
* corrected typos
* corrected typo
* changed version
* fixed problems connected with docker and debugtoolbar
* fix a simple typo
#### Docs

* added docs
* added documentations
38 changes: 35 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,14 @@ Here is how to do that.

1. Clone this github repo
2. Make changes

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think that it can do who make a release, so i think that it's not needed here

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Arfey
Could you please take a look CONTRIBUTING.md file one more time? I added "Managing releases in a repository" part in this file. If that is not enough, could you please advise what else should I add?

> **Note**: _Please make commits according to topic "Conventional Commits", see below_

3. `make test` command must exit without errors
4. Add your name to [CONTRIBUTORS.txt](https://github.com/aio-libs/create-aio-app/blob/master/CONTRIBUTORS.txt) to leave a trace in history 😀
5. Make pull request
6. If you change some `ui` of project, do not forget to add a screenshot with the changes
4. Don't forget to use `make changelog` command for generating CHANGELOG.md file
5. Add your name to [CONTRIBUTORS.txt](https://github.com/aio-libs/create-aio-app/blob/master/CONTRIBUTORS.txt) to leave a trace in history 😀
6. Make pull request
7. If you change some `ui` of project, do not forget to add a screenshot with the changes

```bash
git clone https://github.com/aio-libs/create-aio-app.git
Expand All @@ -25,6 +29,34 @@ make
open http://localhost:8080
```

## Conventional Commits

A specification for adding human and machine readable meaning to commit messages. The commit message should be structured as follows:

```
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
```

The commit contains the following structural elements, to communicate intent to the consumers of your application/library:

1. **fix**: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning).
1. **feat**: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).
1. **BREAKING CHANGE**: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in semantic versioning). A BREAKING CHANGE can be part of commits of any type.
1. **types other than fix: and feat:** are allowed, for example @commitlint/config-conventional recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
1. **footers other than BREAKING CHANGE**: <description> may be provided and follow a convention similar to git trailer format.

Example of conventional commit:

```
docs: add description of conventional commits to CONTRIBUTING.md file
```

Full description of [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/).

## Some possible ideas for the pull requests

- [good first issue](https://github.com/aio-libs/create-aio-app/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - list of easy issues with description on what is have to be done
Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTORS.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
- Contributors -
----------------
Aleksandr Leonov
Alexandr Hladyshenko
Alexandre Menezes
Alexey Dyatlov
Expand Down
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,7 @@ test:

ci: flake test

changelog:
auto-changelog

.PHONY: all flake test vtest cov clean doc ci
1 change: 1 addition & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
auto-changelog==0.4.0
bandit==1.6.2
flake8==3.7.9
flake8-bugbear==20.1.4
Expand Down