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

Refactor: Add CONTRIBUTING.md and/or update PR template with [no ci] tips #7657

Closed
mofosyne opened this issue May 30, 2024 · 4 comments
Closed

Refactor: Add CONTRIBUTING.md and/or update PR template with [no ci] tips #7657

mofosyne opened this issue May 30, 2024 · 4 comments
Assignees
@mofosyne
Labels
devops improvements to build systems and github actions documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed low severity Used to report low severity bugs in llama.cpp (e.g. cosmetic issues, non critical UI glitches)

Comments

@mofosyne
Copy link
Collaborator

mofosyne commented May 30, 2024 •
edited by ggerganov
Loading

Background Description

Discussion in #7650 pointed out a need to add a CONTRIBUTING.md and maybe add a PR template to encourage contributors to add [no ci] tag to documentation only changes.

https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs

(If anyone wants to tackle this, feel free to)

Possible Refactor Approaches

Add info about

  • doc only changes should have [no ci] in commit title to skip the unneeded CI checks.
  • squash on merge with commit title format: "module : some commit title (#1234)"
@mofosyne mofosyne added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed devops improvements to build systems and github actions low severity Used to report low severity bugs in llama.cpp (e.g. cosmetic issues, non critical UI glitches) labels May 30, 2024
@mofosyne mofosyne changed the title Refactor: Add CONTRIBUTING.md and/or update issue template with PR tips Refactor: Add CONTRIBUTING.md and/or update PR template with [no ci] tips May 30, 2024
@nicolasperez19
Copy link
Contributor

Hi! I'm new and would like to contribute to the repo! Is it fine if I can take on this issue?

@nicolasperez19
Copy link
Contributor

I'll get on working on it. Thank you!

@mofosyne
Copy link
Collaborator Author

mofosyne commented Jun 2, 2024

No probs @nicolasperez19 , don't spend too much work on making it perfect.

Get the general outline first and make the PR a draft. I think we still need to make sure there is a consensus on how this should work first.

@nicolasperez19 nicolasperez19 mentioned this issue Jun 2, 2024
Merged
@nicolasperez19
Copy link
Contributor

@mofosyne I just submitted the PR. You can take a look and feel free to make any changes.

@mofosyne mofosyne self-assigned this Jun 2, 2024
@mofosyne mofosyne closed this as completed Jun 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mofosyne mofosyne

Labels
devops improvements to build systems and github actions documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed low severity Used to report low severity bugs in llama.cpp (e.g. cosmetic issues, non critical UI glitches)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mofosyne @nicolasperez19