Skip to content

docs: Suggest cloning a fork [ci skip]#3614

Merged
rjsparks merged 1 commit intoietf-tools:mainfrom
jimfenton:clonefork
Mar 11, 2022
Merged

docs: Suggest cloning a fork [ci skip]#3614
rjsparks merged 1 commit intoietf-tools:mainfrom
jimfenton:clonefork

Conversation

@jimfenton
Copy link
Copy Markdown
Collaborator

@jimfenton jimfenton commented Mar 10, 2022

Ready to be merged.

@jimfenton jimfenton changed the title Suggest cloning a fork rather than ietf-tools repo Suggest cloning a fork. Ready to be merged. Mar 10, 2022
@jimfenton jimfenton changed the title Suggest cloning a fork. Ready to be merged. docs: Suggest cloning a fork [ci skip] Mar 10, 2022
@rjsparks
Copy link
Copy Markdown
Member

Hi Jim - we don't need the "ready for merge" convention anymore - PRs signal that by themselves.
Note that we want Conventional Commit formatted commit messages, not just PR titles.

@rjsparks rjsparks merged commit ccae601 into ietf-tools:main Mar 11, 2022
@jimfenton
Copy link
Copy Markdown
Collaborator Author

Got it: As you can see from my title edits, there was a little trial and error on this one. The semantic pull request checker says it's happy if one of the commits or the title of the pull request follow the guidelines, but apparently that is configured differently here. Maybe the CONTRIBUTING guide should be a little more specific on that; right now it just says "Consider starting the commit message..."

@jimfenton jimfenton deleted the clonefork branch March 11, 2022 01:45
@NGPixel
Copy link
Copy Markdown
Member

NGPixel commented Mar 11, 2022

@jimfenton I updated the guide with clearer instructions and examples:

https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md#git-commit-messages

@jimfenton
Copy link
Copy Markdown
Collaborator Author

That makes it clearer for me; thanks.

Also, it may be due to my GitHub security configuration (2FA, SSH keys) or the fact that I'm using Sourcetree, but I wasn't able to push to my forked repo when I used https://github.com/jimfenton/datatracker.git . I had to adjust my URL to git@github.com:jimfenton/datatracker.git to get it to work. I don't know how general this problem is though, so I don't know how it should be represented in the README.

@NGPixel
Copy link
Copy Markdown
Member

NGPixel commented Mar 11, 2022

This is normal, as https://github.com/jimfenton/datatracker.git is an HTTPS/Basic authentication format URI. When using SSH keys, you must use the git@github.com:jimfenton/datatracker.git format.

When clicking the Code button on a repo, you're presented with both the HTTPS and SSH options, each with their proper URI.

jennifer-richards added a commit that referenced this pull request Mar 15, 2022
* chore: bring docker dev init script up to date with bs5 branch (#3611)

* ci: only run codeql on schedule

* feat: shorten long agenda filter button labels (#3602)

Sessions with long names lead to poor rendering of the agenda filter buttons
on the 'customize the agenda view' page. This truncates those labels at 3 words.

* docs: Remove stale and incomplete information from the README (#3612)

* docs: Suggest cloning a fork rather than ietf-tools repo (#3614)

* docs: update README

* chore: add issue templates

* chore: update issue templates config

* chore: remove duplicate security issue link

* docs: point feature requests to discussions

* chore: add bug report form

* chore: remove bug report issue template

* chore: fix bug report form

* fix: point the api index page into Github instead of trac/svn

* chore: remove os + version + log fields from bug report form

* fix: point to GitHub for bug reports (#3625)

* fix: point to GitHub for bug reports

* fix: point report bug link to template chooser

* fix: point report bug link to template chooser (2)

Co-authored-by: Nicolas Giard <github@ngpixel.com>

* fix: remove stale explanation of status reports (#3628)

* fix: adjust about page to reflect move to GitHub. Normalize information level on page. (#3629)

* fix: remove anchor tag with empty href (#3630)

* fix: use same github issue URL on 500 error page as elsewhere (#3631)

* chore: update report-a-bug.yml form

* ci: fix __init__.py version quotes

* chore: bring docker-compose to root level (#3642) (#3643)

Authored-by: Nicolas Giard <github@ngpixel.com>

Co-authored-by: Nicolas Giard <github@ngpixel.com>
Co-authored-by: Robert Sparks <rjsparks@nostrum.com>
Co-authored-by: Jim Fenton <fenton@bluepopcorn.net>
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jun 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants