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

Update documentation #274

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Update documentation #274

merged 1 commit into from
Dec 10, 2024

Conversation

uuf6429
Copy link
Contributor

@uuf6429 uuf6429 commented Dec 7, 2024 •
edited
Loading

Based on #275.

Mainly this is a small update to documentation (contrib and readme).
There are, however, some additional non-functional fixes:

  • added a basic .editorconfig
  • updated gitattributes
  • gitignored local phpunit.xml file (standard convention)
  • updated documentation:
    • used hashes instead of lines for headers
    • fixed some wording
    • used proper code fencing (no space before language)
    • shell instead of bash
    • fixed broken reference to CHANGES.md
    • http -> https
  • initial work for linting tools* (empty composer script; section in documentation)

* which will come soon, hopefully.

uuf6429
uuf6429 commented Dec 7, 2024
View reviewed changes
.gitattributes Outdated Show resolved Hide resolved
uuf6429
uuf6429 commented Dec 7, 2024
View reviewed changes
.gitattributes Show resolved Hide resolved
@uuf6429 uuf6429 force-pushed the chore/update-documentation branch from 337ce32 to 99d108d Compare December 7, 2024 16:39
@uuf6429 uuf6429 mentioned this pull request Dec 7, 2024
Draft
@uuf6429 uuf6429 marked this pull request as draft December 8, 2024 15:59
acoulton
acoulton reviewed Dec 9, 2024
View reviewed changes
Copy link
Contributor

@acoulton acoulton left a comment

Choose a reason for hiding this comment

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

thanks, a few thoughts

.github/workflows/build.yml Outdated Show resolved Hide resolved
.gitattributes Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@acoulton
Copy link
Contributor

acoulton commented Dec 9, 2024

oops sorry, just seen you submitted #275 separately

@uuf6429 uuf6429 force-pushed the chore/update-documentation branch 2 times, most recently from e2cae5a to 24fc11a Compare December 10, 2024 07:10
@uuf6429 uuf6429 marked this pull request as ready for review December 10, 2024 07:14
@uuf6429 uuf6429 requested a review from acoulton December 10, 2024 07:14
acoulton
acoulton approved these changes Dec 10, 2024
View reviewed changes
Copy link
Contributor

@acoulton acoulton left a comment

Choose a reason for hiding this comment

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

LGTM, thanks 😀

carlos-granados
carlos-granados approved these changes Dec 10, 2024
View reviewed changes
Copy link
Contributor

@carlos-granados carlos-granados left a comment

Choose a reason for hiding this comment

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

Looks good, thanks @uuf6429 There are some conflicts that need to be solved, could you please look into that?

@uuf6429 uuf6429 force-pushed the chore/update-documentation branch from 24fc11a to 05dbf33 Compare December 10, 2024 08:06
@carlos-granados carlos-granados merged commit 6b652ca into Behat:master Dec 10, 2024
6 checks passed
@uuf6429 uuf6429 deleted the chore/update-documentation branch December 10, 2024 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carlos-granados carlos-granados carlos-granados approved these changes

@acoulton acoulton acoulton approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@uuf6429 @acoulton @carlos-granados