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

Pitch model building #1

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .flake8
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[flake8]
exclude = meta/migrations/, docs/
max-line-length=100
max-line-length=100
36 changes: 36 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
exclude: 'docs|node_modules|migrations|.git|.tox'
default_stages: [commit]
fail_fast: true

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.3.0
hooks:
- id: check-json
- id: end-of-file-fixer
- id: trailing-whitespace
- id: pretty-format-json
args:
[
"--autofix", # Autofix JSONs
]
- id: check-added-large-files

- repo: local
hooks:
- id: black
name: black
entry: black
language: python
types: [ python ]
- id: isort
name: isort
entry: isort
language: python
types: [ python ]
args: ["--profile", "black"]
- id: flake8
name: flake8
entry: flake8
language: python
types: [python]
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ install:
- pip install -r requirements.txt
- pip install -r tests/test_requirements.txt

# commands to run tests
# commands to run tests
script:
- flake8
- pylint */*.py
Expand Down
2 changes: 0 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,3 @@ Here is a template for new release sections

### Removed
- yet another thing


28 changes: 14 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@

### Philosophy

Development of a feature for this repository should follow the workflow described
Development of a feature for this repository should follow the workflow described
by [Vincent Driessen](https://nvie.com/posts/a-successful-git-branching-model/).

Here are the minimal procedure you should follow :
Here are the minimal procedure you should follow :

#### Step 1: Describe the issue on github

Expand All @@ -30,9 +30,9 @@ it through first).
If you are fixing and error you can replace `feature/` by `fix/`.
2. Try to follow [these conventions](https://chris.beams.io/posts/git-commit) for commit messages:
- Keep the subject line [short](https://chris.beams.io/posts/git-commit/#limit-50) (i.e. do not commit more than a few changes at the time)
- Use [imperative](https://chris.beams.io/posts/git-commit/#imperative) for commit messages
- Do not end the commit message with a [period](https://chris.beams.io/posts/git-commit/#end)
You can use
- Use [imperative](https://chris.beams.io/posts/git-commit/#imperative) for commit messages
- Do not end the commit message with a [period](https://chris.beams.io/posts/git-commit/#end)
You can use
```bash
git commit --amend
```
Expand All @@ -48,12 +48,12 @@ it through first).

#### Step 3: Run tests locally

To run tests locally, install the dependencies
```bash
pip install -r tests/test_requirements.txt
To run tests locally, install the dependencies
```bash
pip install -r tests/test_requirements.txt
```

1. Integration/unit tests
1. Integration/unit tests
```bash
pytest tests
```
Expand All @@ -67,7 +67,7 @@ pip install -r tests/test_requirements.txt
```
You can fix the linting errors either manually or with the packages
`autopep8` or `black` for example.

#### Step 4: Submit a pull request (PR)

Follow the [steps](https://help.github.com/en/articles/creating-a-pull-request) of the github help to create the PR.
Expand Down Expand Up @@ -112,7 +112,7 @@ Your `CHANGELOG.md` file could look like this before the release
### Added
- feature 1
- feature 2
### Changed
### Changed
- thing 1
- thing 2
### Removed
Expand All @@ -126,7 +126,7 @@ Simply replace `unreleased` by `X.Y.Z` and add the date of release in [ISO forma

### Added
-
### Changed
### Changed
-
### Removed
-
Expand All @@ -135,7 +135,7 @@ Simply replace `unreleased` by `X.Y.Z` and add the date of release in [ISO forma
### Added
- feature 1
- feature 2
### Changed
### Changed
- thing 1
- thing 2
### Removed
Expand All @@ -152,7 +152,7 @@ git checkout release/vX.Y.Z
```
git pull
```

```
git checkout dev
```
Expand Down
2 changes: 2 additions & 0 deletions steel_industry/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
COLLECTIONS_DIR = ./collections/
STRUCTURES_DIR= ""
File renamed without changes.
Empty file.

Large diffs are not rendered by default.

Loading