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

Add Well-Understood paper to front page description #3705

Closed
wants to merge 38 commits into from

Conversation

daijingz
Copy link
Contributor

@daijingz daijingz commented Mar 26, 2024

@samm82 Wait a moment for the new updates.
Inherited from previous PR #3686, but with some changes. Please wait for some further checks.

Closes #3360

Newest inspection: Coding style requirements.

  • Double spaces of indent levels.
  • Camel case variable names
  • Correct meaningful variable names.
  • Single blank lines between top-level objects.

Copy link
Owner

@JacquesCarette JacquesCarette left a comment

Choose a reason for hiding this comment

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

The changes to the Website are far from pretty... but at (unfortunately) quite consistent with just how bad this code is. So those two changes are ok. Just the change to README needs improved.

README.md Outdated
@@ -21,7 +21,7 @@ Generate all the Things! Visit [our website](https://jacquescarette.github.io/Dr

## What is Drasil?

For well understood domains, building software ought to be a matter of engineering, based on solid scientific foundations. The ultimate test of "well understood" is being able to teach the domain language to a computer. Drasil is a framework for generating all of the software artifacts for (well understood) research software, from the natural knowledge base of the domain.
For well understood domains, building software ought to be a matter of engineering, based on solid scientific foundations. The ultimate test of "well understood" is being able to teach the domain language to a computer. Drasil is a framework for generating all of the software artifacts for (well understood) research software, from the natural knowledge base of the domain. The exhaustive summary of [well-understood](https://github.com/JacquesCarette/Drasil/blob/master/Papers/WellUnderstood/wu.pdf) domains and our original ideas include Drasil's primary information.
Copy link
Owner

Choose a reason for hiding this comment

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

Rather than this, I would make "(well understood) research software" in the previous line be a link to the paper, and skip this whole new sentence.

@samm82
Copy link
Collaborator

samm82 commented Mar 26, 2024

Also @daijingz, it's better to make any changes in a branch on your fork so that you don't need to "revert" your changes on your master branch, effectively removing your work from the PR (like in #3686).

@daijingz
Copy link
Contributor Author

daijingz commented Mar 27, 2024

Also @daijingz, it's better to make any changes in a branch on your fork so that you don't need to "revert" your changes on your master branch, effectively removing your work from the PR (like in #3686).

There are two existing branches in my personal machine for other issues, and I will use your described tools.
@JacquesCarette sorry for concerns, I will improve in the future.

namedRef icsePositionPaper (S "Old Position Paper") +:+ S "outlining our original ideas, a" +:+
namedRef danPoster (S "Drasil Poster") +:+ S ", and a" +:+
namedRef wellUnderstoodPaper (S "Well-Understood Paper") +:+ S "discussing key concepts."
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should use foldlList, or something similar. I seem to remember describing how to do this, as well as some other improvements, in a previous PR; you can use that as reference!

@daijingz
Copy link
Contributor Author

daijingz commented Apr 9, 2024

Sorry everyone, there are some non-personal issues taking place on my PC, and I am going to go to repair stores tomorrow. I will get back tomorrow.

@daijingz
Copy link
Contributor Author

daijingz commented Apr 17, 2024

@samm82 Newest update: have built two reusable wiki page sentences. This modification has some naming problems, and I am checking.

For the foldlList, I did not find some relevant code sections in the same program file. There is an example in this program file, however, it was used to represent an object list, where each hyperlink is separated by commas. However, this cannot work perfectly in the paragraph, as you can see, the input of foldlList has two input types: hyperlinks and sentences but this function can only have one type.

Can you show me the corresponding foldlList PR?

@daijingz
Copy link
Contributor Author

Up to now my PR has a lot of commits, do not worry, later I will git rebase.

code/drasil-website/lib/Drasil/Website/About.hs Outdated Show resolved Hide resolved
code/drasil-website/lib/Drasil/Website/About.hs Outdated Show resolved Hide resolved
@daijingz
Copy link
Contributor Author

daijingz commented Jun 5, 2024

Sure, let me think about changing it (Really messy in the commit message right now)

Meet some problems right now, because the squash option is disabled.
Maybe the failure is because of my branch Drasil_Copy_1 usages, so that all previous commits are temporarily disabled.

Up to now I am unable to get back to my master branch, and here is the error message:
6cd7bf250276f7b76a0ce069de93c243

I guess the most possible case is because Dr.Carette had not merged this PR from the master's branch, but merged another now from the copy branch. @samm82 Can you give me some help to fix this?

@balacij
Copy link
Collaborator

balacij commented Jun 6, 2024

What is that error message from?

@smiths
Copy link
Collaborator

smiths commented Jun 6, 2024

@balacij you provide some great advice above. Can you or one of the summer students add this advice to our Contributor's Guide? I like your advice about squashing commits and only merging with master when necessary. Your advice on commit messages is also valuable. We might already have some of this in the Contributor's guide.

@daijingz
Copy link
Contributor Author

daijingz commented Jun 9, 2024

What is that error message from?

@balacij From Git Desktop, when I switched my current branch to master, it had this error message.

I tried to use commands today but it did not work. Also, when I selected multiple commits, by right-clicking, the option squash ... commits was in grey, meaning it was unavailable. I guess there are some problems, but I have not found an efficient way to solve this, and others feel unfamiliar with this error. Please help me.

@JacquesCarette There is a new PR completed today, should I submit before fixing this error?
Here is the screenshot:
3d6ffbce94515e7d7e2f52fd98d42276

@balacij
Copy link
Collaborator

balacij commented Jun 11, 2024

@daijingz Can you please try out the branch in #3793 ? I think that should fix your issue.

@daijingz
Copy link
Contributor Author

@daijingz Can you please try out the branch in #3793 ? I think that should fix your issue.

Sure

@balacij balacij changed the title Contributes to issue: Should add Well-Understood paper to front page description #3360 (Attempt) Add Well-Understood paper to front page description Jun 11, 2024
@daijingz daijingz requested a review from balacij as a code owner June 15, 2024 00:52
@daijingz
Copy link
Contributor Author

daijingz commented Jun 15, 2024

Fixed. Now I can squash commits, and please wait a moment.
There is a problem: on the GitHub desktop, I tried to drag my commits to the target squash commit. It shows a lot of options after choosing to squash. However, after determined to squash, I did not see any response from the commit message terminal. That is, the original two commits did not combine, and they stayed separate as before.
@samm82 @balacij do you have office hour so that I can get assistance? But just wait for a few minutes, because I am still trying other ways.

f0676515414b748d9e41685551d20fd8

After this page, it shows that squash success, but I did not find any change on the same page (it seems like there is nothing change):
e686895e7b931005582d78e9c695148c

@balacij
Copy link
Collaborator

balacij commented Jun 20, 2024

It looks like in c6971a3 - 767c18e, you duplicated my changes in #3793 -- I don't think you needed to do this. Instead, you could have pulled in my changes from my PRs source branch. Alternatively, now, you can merge in master or main (note: we're switching to main now, instead of master, as our 'main' development branch).

I'm not at all familiar with GitHub Desktop, and I don't normally host office hours during the summer. However, I can try to help you here. For starters, I think you should duplicate your working branch (i.e., create a backup before making commit history changes!). Then, you can do a git rebase -i HEAD~37 (using 37 because I see your PR has 37 commits, so rebase the last 37 commits) in your terminal to re-order and merge commits together (via marking some as being fixups of others).

@balacij balacij changed the base branch from master to main June 20, 2024 15:52
@daijingz
Copy link
Contributor Author

daijingz commented Jun 24, 2024

@balacij Do you have time tomorrow? Let me go to the campus if you are available, is it Ok?

Right now I feel some parts of the problems I have never seen before, and I did not have enough fixing information here.

@balacij
Copy link
Collaborator

balacij commented Jun 27, 2024

Regrettably, that time has past. Do you have any specific topics you need help with? I could try to direct you to some resources or help you here first.

@daijingz
Copy link
Contributor Author

daijingz commented Jul 2, 2024

Fixing it, but right now I spend a lot of time working with squashing commits, with many different methods' usages. However, none of them have successful results.

Two used methods:

  1. Directly change from Github Desktop.
  2. Use commands on the cgywin64 terminal.

Both sides have the same result: the page just indefinitely processing, without any progresses.

More information is coming.

@balacij
Copy link
Collaborator

balacij commented Jul 5, 2024

I'm not quite sure what squashing has to do with this using GitHub Desktop app or Cygwin. However, if you're having troubles with checking out the repo still, it is probably worth it for you to switching to a 'Linux subsystem for Windows'-based development workflow. In other words, having all development go through WSL -- thereby allowing you to checkout the one file that broke compatibility on Windows temporarily.

Regarding squashing commits, you can either:

  1. git rebase -i and mark commits as 'fixup's of others to clean up the commit history (you can do this gradually! i.e., 2-3 rebases), or
  2. just reset the branch locally (i.e., without pushing! -- i.e., without closing the PR!) and manually re-apply the necessary patches, and then force-push to your branch, thereby erasing the old change history.

Going through (1) is surprisingly satisfying!

@daijingz daijingz closed this by deleting the head repository Jul 19, 2024
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.

Should add Well-Understood paper to front page description
5 participants