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 README.md contributor and release docs #237

Merged
merged 14 commits into from
Mar 26, 2024
Merged

Update README.md contributor and release docs #237

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
4e2e8e7
Update README.md contributor and release docs
YesCT Jul 27, 2023
79dba39
NOTICKET: Out of scope change, gitignore editors/OS.
YesCT Aug 7, 2023
8cfd29d
Merge branch 'main' into NOTICKET--readme-contributor-release-docs
YesCT Aug 7, 2023
bd69d19
NOTICKET: Add semver and suggestion for release numbering.
YesCT Aug 7, 2023
e47f390
NOTICKET: Update README.md TOC.
YesCT Aug 7, 2023
593255c
Update README.md grammar.
YesCT Aug 7, 2023
f2c714a
Merge branch 'main' into NOTICKET--readme-contributor-release-docs
YesCT Mar 12, 2024
bc05bc3
NOTICKET: Update README.md TOC.
YesCT Mar 12, 2024
e2867d2
Update README.md
davereid Mar 14, 2024
8c9fefc
Updated doctoc.
davereid Mar 21, 2024
e12f930
Merge branch 'main' into NOTICKET--readme-contributor-release-docs
davereid Mar 21, 2024
87ec026
Merge branch 'main' into NOTICKET--readme-contributor-release-docs
davereid Mar 21, 2024
c9a6d95
Fixed Releases subsections.
davereid Mar 21, 2024
c394f90
Update README.md
davereid Mar 25, 2024
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
7 changes: 7 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,10 @@ tests/fixtures/drainpipe-test-project/*
!.yarn/sdks
!.yarn/versions
.npmrc

################
# Editors / OS #
################
.idea
.DS_Store
.vscode
Comment on lines +18 to +23
Copy link
Member

Choose a reason for hiding this comment

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

@YesCT you might be interested in https://github.com/github/gitignore/tree/main?tab=readme-ov-file. It's generally recommended to put these in your global .gitignore so it automatically applies to all projects.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will do. And I'll pass on that feedback to our other projects where we add this.

20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,3 +543,23 @@ tugboat:php:init:
- apt-get install -y libldap2-dev
- docker-php-ext-install ldap
```

## Contributor Docs

This repo is public.

Please be careful to remove sensitive customer specifics when posting Issues or comments.

Firsttime contributors need a maintainers approval for automated tests to run.
YesCT marked this conversation as resolved.
Show resolved Hide resolved
(This is so we aren't at risk of getting a big CI bill accidentally, or maliciously.)

Peer Reviewing by looking at PR code changes is nice.

Testing PR code changes on real sites is extra beneficial.

## Release

The https://github.com/Lullabot/drainpipe/actions/workflows/DrainpipeDev.yml action needs some manual follow-ups
to remove the branch name, so that the tag and branch name being the same doesn't cause complications.

Before making a new release, post in the lullabot internal #devops slack channel to coordinate with other maintainers.