-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Fixing restyled to ignore third_party #392
Changes from all commits
6837478
b011353
4b0f067
c721a3e
2f555d3
4c23518
10991d9
1d6b82c
3309b40
776362f
3f655f9
6e32a20
f35b65f
e407ce3
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
# Do anything at all | ||
enabled: true | ||
|
||
# Push the style fixes directly to the original PR | ||
auto: false | ||
|
||
# Open Restyle PRs? | ||
pull_requests: true | ||
|
||
# Add labels to any created Restyle PRs | ||
labels: | ||
- restyled | ||
|
||
# Labels to ignore | ||
ignore_labels: | ||
- restyled-ignore | ||
|
||
# Leave comments on the original PR linking to the Restyle PR? | ||
comments: false | ||
|
||
# Request review on the Restyle PR | ||
request_review: none | ||
|
||
# Patterns to exclude from all Restylers | ||
exclude: | ||
- ".github/workflows/**/*" # https://github.com/restyled-io/restyler/issues/73 | ||
- "third_party/**/*" | ||
- "third_party/**" | ||
- "third_party/*" | ||
- "build/**/*" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we want restyled looking at build, as long as the files are part of the git repository There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "We want" can you explain? which we don't want? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we want restyled to look at all the things in build/ that are in git There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should be addressed separately. For now, we're should ignore build, we can bring this back in later. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Aside: Ideally, we should have a real build directory then, given it's a mix of built products, and scripts |
||
- "autom4te.cache/**/*" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. there are no files in this directory in git... There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yup, but it matters for locally restyled There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. restyled can't look at .gitignore? I guess this is no biggie, but it means .gitignore and this file have to be kept in sync. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Correct, feel free to open up an issue there. |
||
|
||
# Restylers to run, and how | ||
restylers: | ||
- name: clang-format | ||
enabled: true | ||
image: restyled/restyler-clang-format:v9.0.0 | ||
command: | ||
- clang-format | ||
- "-i" | ||
arguments: [] | ||
include: | ||
- "**/*.c" | ||
- "**/*.cc" | ||
- "**/*.cpp" | ||
- "**/*.cxx" | ||
- "**/*.c++" | ||
- "**/*.C" | ||
- "**/*.cs" | ||
- "**/*.h" | ||
- "**/*.hh" | ||
- "**/*.hpp" | ||
- "**/*.hxx" | ||
- "**/*.h++" | ||
- "**/*.H" | ||
- "**/*.java" | ||
- "**/*.js" | ||
- "**/*.m" | ||
interpreters: [] | ||
- name: jq | ||
enabled: true | ||
include: | ||
- "**/*.json" | ||
- name: prettier-markdown | ||
enabled: true | ||
include: | ||
- "**/*.md" | ||
- "**/*.markdown" | ||
- name: prettier-yaml | ||
enabled: true | ||
include: | ||
- "**/*.yml" | ||
- "**/*.yaml" | ||
- name: shellharden | ||
enabled: true | ||
include: | ||
- "**/*.sh" | ||
- "**/*.bash" | ||
- name: shfmt | ||
enabled: true | ||
include: | ||
- "**/*.sh" | ||
- "**/*.bash" |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,51 @@ | ||
## CHIP Project Flow | ||
|
||
This section is intended to cover how CHIP uses GitHub Projects, | ||
Issues, Milestones, Releases, and Branches for program/project | ||
management in the code repository. | ||
This section is intended to cover how CHIP uses GitHub Projects, Issues, | ||
Milestones, Releases, and Branches for program/project management in the code | ||
repository. | ||
|
||
### Issues | ||
|
||
CHIP uses issues as simple problem descriptions or feature requests. In | ||
general, all work contributed to the repository in the form of pull requests | ||
(PR) should be under the auspices of some open issue. This may seem onerous and | ||
in some cases duplicative, so consider these guidelines when deciding whether to | ||
you can get away with not creating an issue: | ||
|
||
* Trivial fixes: issues can function as TODO lists, simple reminders that | ||
something should be addressed. Sometimes, though, the work required to | ||
fix is smaller than the work required to write the issue. | ||
* Issues intended to be addressed by a PR may not actually be fixed or | ||
may regress. | ||
* Issues can span PRs (as PRs should be as small as possible, but no smaller). | ||
* Issues help form an important basis for release notes. Any PR that addresses | ||
a problem that should have release visibility, please do open an issue. | ||
CHIP uses issues as simple problem descriptions or feature requests. In general, | ||
all work contributed to the repository in the form of pull requests (PR) should | ||
be under the auspices of some open issue. This may seem onerous and in some | ||
cases duplicative, so consider these guidelines when deciding whether to you can | ||
get away with not creating an issue: | ||
|
||
- Trivial fixes: issues can function as TODO lists, simple reminders that | ||
something should be addressed. Sometimes, though, the work required to fix is | ||
smaller than the work required to write the issue. | ||
- Issues intended to be addressed by a PR may not actually be fixed or may | ||
regress. | ||
- Issues can span PRs (as PRs should be as small as possible, but no smaller). | ||
- Issues help form an important basis for release notes. Any PR that addresses a | ||
problem that should have release visibility, please do open an issue. | ||
|
||
### Pull requests | ||
|
||
Pull requests should be small and address a single, specific change to the code | ||
base. They should be easy to review, as a "yes, that's better". Refrain from | ||
base. They should be easy to review, as a "yes, that's better". Refrain from | ||
requesting review until all PR checks have completed successfully, lest you tire | ||
your reviewers. | ||
|
||
PR Don'ts: | ||
* Don't combine unrelated changes. E.g. if the PR addresses a bug in some | ||
C code, an update to the top-level .gitignore doesn't belong. | ||
* Don't make stacks. E.g. if a change in a component requires a new feature | ||
or even a small tweak in one or more of its dependencies, each dependency | ||
change belongs in its own separate PR. | ||
|
||
- Don't combine unrelated changes. E.g. if the PR addresses a bug in some C | ||
code, an update to the top-level .gitignore doesn't belong. | ||
- Don't make stacks. E.g. if a change in a component requires a new feature or | ||
even a small tweak in one or more of its dependencies, each dependency change | ||
belongs in its own separate PR. | ||
|
||
### Milestones | ||
|
||
In CHIP parlance, a milestone is simply an expected due date or release. | ||
|
||
Date-based milestones start with an "M" and have the form M3, M3.2, M4, | ||
etc. corresponding to the number of months since January 1, 2020, and generally | ||
mean the last Friday of that month. E.g. M1 corresponds to EOB January 24, | ||
2020. The Morrow milestone is a special milestone that means "unprioritized" or | ||
"unscheduled" or "unscoped". | ||
Date-based milestones start with an "M" and have the form M3, M3.2, M4, etc. | ||
corresponding to the number of months since January 1, 2020, and generally mean | ||
the last Friday of that month. E.g. M1 corresponds to EOB January 24, | ||
|
||
2020. The Morrow milestone is a special milestone that means "unprioritized" or | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is a misfire, "2020." isn't a numbered list item. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's following the default .md formatter. Do we have a config anywhere we should use? We are not going to manually verify each thing the restyler does and accept/decline it. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we should probably just trick the thing by wrapping it another way yes: I plan to verify everything the restyler does, lest we break our tree. |
||
"unscheduled" or "unscoped". | ||
|
||
The form of the names of release-based milestone names are TBD, and may have | ||
flexible or changing dates. | ||
|
@@ -53,20 +54,20 @@ flexible or changing dates. | |
|
||
Projects are collections of issues, pull requests, and notes intended to capture | ||
larger efforts that don't fit in issues, have multiple-subsystems involved, or | ||
may span multiple milestones. We use projects 2 ways: | ||
may span multiple milestones. We use projects 2 ways: | ||
|
||
1. To track burn down on a larger task. When constructing such a project, it's | ||
important to think in terms of something that will eventually have | ||
an end, i.e. a definite scope. | ||
1. To track burn down on a larger task. When constructing such a project, it's | ||
important to think in terms of something that will eventually have an end, | ||
i.e. a definite scope. | ||
2. To categorize issues, denote broader efforts without a definite time scope. | ||
These projects might reflect or show burndown or percent complete, but are mostly | ||
used to view where effort is going. | ||
These projects might reflect or show burndown or percent complete, but are | ||
mostly used to view where effort is going. | ||
|
||
Issues can belong to any number of projects, but should generally only belong to | ||
one of the task-tracking projects (the first type). | ||
|
||
### Branches, releases, and general development flow | ||
|
||
Master should always be CHIPs best branch. Release branches, once cut, are | ||
closed for any feature work. Software fixes for release branches must first | ||
land on master unless demonstrably infeasible. | ||
Master should always be CHIPs best branch. Release branches, once cut, are | ||
closed for any feature work. Software fixes for release branches must first land | ||
on master unless demonstrably infeasible. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is really unfortunate. is restyled really this stupid?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure it is a multiple 'really' level of unfortunate, but it seems to work for now. Trying to pair it back down as I understand their syntax.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed to single level really