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 FAQ to devdocs (Code Howtos) #11456

Merged
merged 3 commits into from
Jul 8, 2024
Merged

Conversation

subhramit
Copy link
Collaborator

@subhramit subhramit commented Jul 5, 2024

This introduces an faq.md inside devdocs (Code Howtos) which is intended to contain common issues faced by developers (e.g. failing tests) while developing JabRef and their most probable solutions.

image

Mandatory checks

  • [ ] Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
  • [ ] Tests created for changes (if applicable)
  • [ ] Manually tested changed features in running JabRef (always required)
  • [ ] Screenshots added in PR description (for UI changes)
  • Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

@subhramit
Copy link
Collaborator Author

Okay apparently inline HTML is not allowed. Will have to let go of the colored text.

@subhramit
Copy link
Collaborator Author

Getting the changed submodules commit issue again.
IntelliJ is already configured as per #11138 (comment)
Would need help fixing this.

@koppor
Copy link
Member

koppor commented Jul 6, 2024

Okay apparently inline HTML is not allowed. Will have to let go of the colored text.

Please bring them back again and let's check how it shows up in "just the docs".

Please configure markdown-lint. A hint was given at https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md. But do it the easy way: Put <!-- markdownlint-disable-file MD033 --> at the end of the md file

@koppor
Copy link
Member

koppor commented Jul 6, 2024

Getting the changed submodules commit issue again. IntelliJ is already configured as per #11138 (comment) Would need help fixing this.

I am sorry that I do not use IntelliJ for committing. I should say to everyone: Please use git gui.

  • Ensure everything is committed
  • gitk --all& (to start gitk to have the commit IDs ready if something goes wrong)
  • git merge upstream/main (to merge the latest upstream changes)
  • git reset upstream/main (to discard all commits and start a fresh commit)
  • git gui (to craft a new commit. Do NOT commit the changes in the submodule. Try to revert these changes using "Commit" -> "Revert Changes")
  • Create a new commit using git gui (maybe other git tooling you use)
  • git push -f (to overwrite the changes also in this PR)

@subhramit
Copy link
Collaborator Author

subhramit commented Jul 8, 2024

Getting the changed submodules commit issue again. IntelliJ is already configured as per #11138 (comment) Would need help fixing this.

I am sorry that I do not use IntelliJ for committing. I should say to everyone: Please use git gui.

  • Ensure everything is committed
  • gitk --all& (to start gitk to have the commit IDs ready if something goes wrong)
  • git merge upstream/main (to merge the latest upstream changes)
  • git reset upstream/main (to discard all commits and start a fresh commit)
  • git gui (to craft a new commit. Do NOT commit the changes in the submodule. Try to revert these changes using "Commit" -> "Revert Changes")
  • Create a new commit using git gui (maybe other git tooling you use)
  • git push -f (to overwrite the changes also in this PR)

Done. Thank you for the detailed steps.
Git GUI is really convenient.

@subhramit
Copy link
Collaborator Author

Okay apparently inline HTML is not allowed. Will have to let go of the colored text.

Please bring them back again and let's check how it shows up in "just the docs".

Please configure markdown-lint. A hint was given at https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md. But do it the easy way: Put <!-- markdownlint-disable-file MD033 --> at the end of the md file

Okay. See if it looks alright.

@calixtus calixtus added this pull request to the merge queue Jul 8, 2024
Merged via the queue into JabRef:main with commit fc46a66 Jul 8, 2024
23 checks passed
@calixtus calixtus deleted the add-devdocs-faq branch July 8, 2024 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants