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.

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

Customize files #5

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Customize files #5

wants to merge 2 commits into from

Conversation

jcbhmr
Copy link
Member

@jcbhmr jcbhmr commented Mar 7, 2023

This PR would... (checkboxes are draft progress)

  • Add header image to readme
  • Add badges to readme
  • Make readme content relevant
  • Refer to original project
  • Remove PR dissuasion PULL_REQUEST_TEMPLATE.md
  • Customize CONTRIBUTING.md to point both to LLVM for code changes, and this project for custom changes
  • Make sure GitHub Actions are ready to enable

Originally this was supposed to be README.markdown so that it was still markdown rendered, but where .ma... was BEORE .md so it "overrode" the main landing document. I decided it's OK to have merge conflicts, as long as those merge conflicts are reasonably limited. For instance, don't rename the llvm directory, don't move everything to packages/*, and don't try to change the general structure. But, changing README.md, adding GitHub Actions, removing the PR thing, and other general customizations are OK. Basically just keep the primary code, change what you need, but don't needlessly customize.

Originally this was supposed to be README.markdown so that it was still markdown rendered, but where .ma... was BEORE .md so it "overrode" the main landing document. I decided it's OK to have merge conflicts, as long as those merge conflicts are reasonably limited. For instance, don't rename the llvm directory, don't move everything to packages/*, and don't try to change the general structure. But, changing README.md, adding GitHub Actions, removing the PR thing, and other general customizations are OK. Basically just keep the primary code, change what you need, but don't needlessly customize.
@jcbhmr jcbhmr marked this pull request as ready for review March 17, 2023 02:50
@jcbhmr jcbhmr self-assigned this Mar 23, 2023
@jcbhmr jcbhmr added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

None yet

1 participant