Skip to content

docs: AI Policy, Coding Tips - #1787

Merged
port19x merged 9 commits into
masterfrom
policy
Sep 30, 2026
Merged

port19x merged 9 commits into
masterfrom
policy

Conversation

@port19x

@port19x port19x commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Template

Type of change

  • Documentation update

Description

resolves #1769

WIP

@port19x port19x changed the title Update CONTRIBUTING.md AI Policy, Coding Tips, Ban Wget Jul 15, 2026
@port19x port19x changed the title AI Policy, Coding Tips, Ban Wget docs: AI Policy, Coding Tips, Ban Wget Jul 15, 2026
@port19x port19x added this to the post 4.15 milestone Jul 20, 2026
Comment thread .github/workflows/ani-cli.yml Outdated
Comment thread .github/workflows/ani-cli.yml Outdated
Co-authored-by: Werryx <53448668+Werryx@users.noreply.github.com>
@port19x

port19x commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator Author

Thanks @Werryx

@port19x
port19x marked this pull request as ready for review July 21, 2026 17:42
@port19x

port19x commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator Author

Also @Derisis13 you randomly added the claude killstring in #1627
Justify it here and we can keep it

@port19x
port19x marked this pull request as draft July 22, 2026 09:21
@port19x

port19x commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator Author

Closing for now, this needs more work in the issue stage

@port19x port19x closed this Jul 23, 2026
@port19x
port19x deleted the policy branch July 30, 2026 10:20
@port19x
port19x restored the policy branch September 30, 2026 19:18
@port19x port19x reopened this Sep 30, 2026
@port19x port19x changed the title docs: AI Policy, Coding Tips, Ban Wget docs: AI Policy, Coding Tips Sep 30, 2026
@port19x
port19x marked this pull request as ready for review September 30, 2026 19:24
@vorlie

vorlie commented Sep 30, 2026

Copy link
Copy Markdown
Collaborator

Lgtm

@vorlie
vorlie self-requested a review September 30, 2026 19:32
@port19x
port19x merged commit 3ad5363 into master Sep 30, 2026
8 checks passed

@justchokingaround justchokingaround left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

the rest looks good, I'm highly in favor of this PR 👍

Comment thread CONTRIBUTING.md
### Coding Tips

- Keep it brief. Your likelihood of being merged is inversely proportional to your change size.
- Use && and || over if-else constructs whereever appropriate

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

*wherever

and also I'd link to this video, I think it's a rly good explanation that many people don't get: https://www.youtube.com/watch?v=p0KKBmfiVl0

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Good video to link

Comment thread CONTRIBUTING.md
- Add the AI model as a coauthor
- Using LLMs as a better search engine is okay
- Using LLMs to remember syntax and idioms is okay
- Using LLMs to verify posix compliance is okay

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

id say rather to refactor into posix compliance ig, bc for posix compliance u should only use shellcheck which is deterministic

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

shellcheck is non-exhaustive with utilities tho, but I can see how that would be covered by "refactor"

Comment thread CONTRIBUTING.md
Comment on lines +31 to +34
Add these two urls into the context, however you do that with your LLM of choice:
- https://github.com/pystardust/ani-cli/blob/master/.github/workflows/ani-cli.yml
- https://github.com/pystardust/ani-cli/blob/master/CONTRIBUTING.md

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

id prefer saying that u should add these two files, not urls, so that people can also figure out that they have them locally as well easier

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

would files/urls work?

@port19x

port19x commented Oct 1, 2026

Copy link
Copy Markdown
Collaborator Author

@justchokingaround if you want to make a PR with your suggestions I'll merge for sure, otherwise I can make one sometime this week

@port19x port19x linked an issue Oct 2, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

What is the AI stance of the project? We should have an official AI policy

5 participants