Skip to content

Commit 1a6001f

Browse files
committed
update format
1 parent 2b3e5ed commit 1a6001f

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

.clang-format

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ BreakConstructorInitializersBeforeComma: false
5757
BreakConstructorInitializers: BeforeColon
5858
BreakAfterJavaFieldAnnotations: false
5959
BreakStringLiterals: true
60-
ColumnLimit: 80
60+
ColumnLimit: 125
6161
CommentPragmas: '^ IWYU pragma:'
6262
QualifierAlignment: Leave
6363
CompactNamespaces: false
@@ -104,7 +104,7 @@ IndentGotoLabels: true
104104
IndentPPDirectives: None
105105
IndentExternBlock: AfterExternBlock
106106
IndentRequires: false
107-
IndentWidth: 2
107+
IndentWidth: 4
108108
IndentWrappedFunctionNames: false
109109
InsertTrailingCommas: None
110110
JavaScriptQuotes: Leave

.pre-commit-config.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ repos:
44
hooks:
55
- id: black
66
language_version: python3
7-
args: [--line-length=125]
7+
args: ['--line-length=125',
8+
'--skip-string-normalization']
89

910
- repo: https://github.com/pre-commit/pre-commit-hooks
1011
rev: v4.3.0

CONTRIBUTING.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
11
# How to Contribute
22

3-
We'd love to accept your patches and contributions to this project.
3+
We'd love to accept your patches and contributions to this project.
44
There are just a few small guidelines you need to follow.
55

66
## Discussion
77

8-
Share your proposal via [Github Issues](https://github.com/fastmachinelearning/hls4ml/issues).
9-
If you are looking for some issues to get started with, we have a list of [good first issues](https://github.com/fastmachinelearning/hls4ml/labels/good%20first%20issue) in the issue tracker.
8+
Share your proposal via [GitHub Issues](https://github.com/fastmachinelearning/hls4ml/issues).
9+
If you are looking for some issues to get started with, we have a list of [good first issues](https://github.com/fastmachinelearning/hls4ml/labels/good%20first%20issue) in the issue tracker.
1010
We also welcome submissions to improve the documentation.
1111

1212
## Pull Request
1313

14-
All submissions, including submissions by project members, require review.
15-
We use GitHub pull requests for this purpose.
14+
All submissions, including submissions by project members, require review.
15+
We use GitHub pull requests for this purpose.
1616
Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.
1717

1818
1. In the pull request description, clearly document all changes made and the expected behavior.
1919
1. If you are introducing new functionality, add at least one unit test under the `test` folder and make sure it passes before you submit the pull request.
2020
1. Similarly, if you are fixing a bug, add at least one unit test under the `test` folder such that the master branch fails the test and your branch passes the test.
21+
1. Install and run `pre-commit` on the files that you have edited. We are adiabatically turning on linting for the full repository (see [#678](https://github.com/fastmachinelearning/hls4ml/pull/678)).
2122
1. Submit the pull request to the [main](https://github.com/fastmachinelearning/hls4ml) branch.
2223

2324
## Code Reviews
2425

25-
We will review your contribution and, if any additional fixes or modifications are necessary, may provide feedback to guide you.
26-
When accepted, your pull request will be merged to the repository.
26+
We will review your contribution and, if any additional fixes or modifications are necessary, may provide feedback to guide you.
27+
When accepted, your pull request will be merged to the repository.
2728

2829
## Code of Conduct
2930

MANIFEST.in

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
include LICENSE README.md CONTRIBUTING.md CITATION.cff pyproject.toml setup.py setup.cfg .clang-format
2-
graft example-prjs
32
graft example-models
43
graft test
54
recursive-include hls4ml/templates *

0 commit comments

Comments
 (0)