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.

Sign up for GitHub

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

Jump to bottom

Explain what's needed to close issues, that aren't reproducable anymore. #2092

Merged
merged 2 commits into from
Feb 13, 2022
Merged

Explain what's needed to close issues, that aren't reproducable anymore. #2092

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b44a1a
Explain what's needed to close issues, that aren't reproducable anymore.
dawedawe Feb 13, 2022
46b9630
Put back trailing spaces.
dawedawe Feb 13, 2022
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
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,9 @@ Filename: `MyNewConceptTests.fs`.

When developing a new feature, add new tests to cover all code paths.

If you come across an issue, which can't be reproduced with the latest version of Fantomas but is still open, please submit a regression test.
That way, we can ensure the issue stays fixed after closing it.

## Guidelines

- Please always rebase your code on the targeted branch.
Expand Down Expand Up @@ -191,8 +194,8 @@ It's often better to check *before* contributing that you're setting off on the
## Fixing style guide inconsistencies

Fantomas tries to keep up with the style guides, but as these are living documents, it can occur that something is listed in the style that Fantomas is not respecting.
In this case, please create an issue using our [online tool](https://fsprojects.github.io/fantomas-tools/#/).
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you've removed a couple of these in other PR's (perhaps automatically via tooling), but please don't remove these spaces.
They introduce a line break (<br /> HTML element).

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh, sorry. That's a setting in my VS Code. I'll keep that in mind.

Copy the code snippet from the guide and add a link to the section of the guide that is not being respected.
In this case, please create an issue using our [online tool](https://fsprojects.github.io/fantomas-tools/#/).
Copy the code snippet from the guide and add a link to the section of the guide that is not being respected.
The maintainers will then add the `bug (stylistic)` to confirm the bug is fixable in Fantomas. In most cases, it may seem obvious that the case can be fixed.
However, in the past there have been changes to the style guide that Fantomas could not implement for technical reasons: Fantomas can only implement rules based on information entirely contained within the untyped syntax tree.

Expand All @@ -202,7 +205,7 @@ When fixing a stylistic issue, please ask the maintainers what branch should be
Strive to ensure that end users can always update to the latest patch revision of their current minor or major without fear.

A user should only need to deal with style changes when they have explicitly [chosen to upgrade](https://github.com/fsprojects/fantomas/blob/master/docs/Documentation.md#updating-to-a-new-fantomas-version) to a new minor or major version.
In case no major or minor branch was created yet, please reach out to the maintainers.
In case no major or minor branch was created yet, please reach out to the maintainers.
The maintainers will frequently rebase this branch on top of the master branch and release alpha/beta packages accordingly.

# Your First Contribution
Expand Down