Contributing to gbforth

First of all, thank you for wanting to contribute to this project! 💚

This page contains a few guidelines for contributing to gbforth. Keep in mind they are mostly guidelines, not hard rules. Use your best judgement and in case of doubt, don’t hesitate to ask questions!

🐞 Reporting a bug

• Search the issues and check if the bug is not already reported.
• If not, create a new issue. Make sure to include a clear description of the issue, and if possible attach a (minimal) code sample that demonstrates the bug.

⚡️ Fixing bugs

• Check the known bugs if you want to help out.
• Open a new pull request with the fix.
• Make sure to include a clear description of the problem and solution.
• Add the related issue number if one exists.

🌀 Refactoring and formatting existing code

• Changes that are cosmetic in nature and do not add anything substantial to the performance, functionality, or stability of gbforth will generally not be accepted.

✅ Improving ANS Forth conformance

• Check the ANS conformance milestones to track the progress.
• Ensure that the runtime and compile time behaviour of new words is working correctly (as far as is possible/reasonable).
• Write at least a basic test for the new word.
• Open a new pull request with your changes.

🚀 Do you want to add a new feature or change an existing one?

• Consider suggesting new features in the issues before writing any code.
• Open a new pull request with your changes.
• Make sure to include a clear description of the change.

👾 Did you write a game or example?

• Add your example to the examples/ folder.
• Make sure to update the Makefile so your example gets build.
• Open a new pull request to merge your example.

📖 Do you want to contribute to the documentation?

• Check the issues for docs for ideas.
• Make sure to add an item to the table of contents if you created a new page.
• Open a new pull request with your changes.

❓ Do you have questions about using or modifying gbforth?

• Feel free to open an issue with your question.