Skip to content

FAQ

Jump to bottom
Joel B edited this page May 9, 2026 · 6 revisions

This page answers common project and contribution questions.

Can I work without an issue?

Usually, no.

Please create or find a GitHub issue before starting work. This keeps the project organized and gives others a chance to comment before time is spent on code.

Small typo fixes may be simple, but creating an issue is still preferred for transparency.

Can I create my own issue?

Yes. If you find a bug, have an idea, or notice documentation that could be improved, create an issue.

When creating an issue:

  • use the correct template
  • describe the problem clearly
  • explain why the change would help
  • add the right label
  • link the issue to the project board

Can I work on more than one issue?

It is better to finish one issue before starting another.

Small focused work is easier to review and easier to merge.

If you want to work on multiple things, use separate branches and separate pull requests.

What if I am stuck?

Ask for help.

When asking, include:

  • what you were trying to do
  • what command you ran
  • what happened
  • what you expected to happen
  • any error message you saw

Being stuck is normal. Clear questions help others help you faster.

Who reviews pull requests?

Another contributor should review your pull request before it is merged.

Reviews help catch bugs, improve readability, and share knowledge across the team.

When can I merge?

Merge after:

  • the pull request has been reviewed
  • requested changes have been handled
  • the linked issue is included in the PR description
  • the change has been tested
  • the team has approved merging

Do not merge directly to master without review.

What should I do after my pull request is merged?

After your pull request is merged:

  1. Switch back to master.
  2. Pull the latest changes.
  3. Delete your old branch if it is no longer needed.
  4. Pick a new issue if you want to continue.

Useful commands:

git checkout master
git pull origin master

Should I delete my branch after merge?

Usually, yes.

Once the pull request is merged and the branch is no longer needed, it can be deleted.

This keeps the repository clean.

Can I change files outside my issue?

Avoid unrelated changes.

If you notice something else that should be fixed, open a separate issue or pull request.

This makes review easier and keeps the project history clear.

Should I include products.db in my pull request?

No.

products.db is local development data and should not be part of normal pull requests.

If it appears in git status, do not stage or commit it.

Do I need automated tests?

For now, manual testing is acceptable for many small changes.

As the project grows, automated tests should be added for important behavior.

If you add or change behavior that is easy to test, adding a simple test is encouraged.

Where should project discussions happen?

Use:

  • GitHub Issues for bugs, tasks, and feature ideas
  • pull request comments for code review
  • Discord for quick discussion and coordination

If a decision affects the project long term, it should be documented in GitHub or the wiki.

Clone this wiki locally