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

Contributing guide changes #18

Merged
merged 14 commits into from
Dec 23, 2024
Merged

Contributing guide changes #18

merged 14 commits into from
Dec 23, 2024

Conversation

cheng-alvin
Copy link
Owner

This Pull request describes the changes that finally concludes the writing of the Jas contribution guide, in particular, this Pull request adds in the common changes and items for developers such as adding new assembler instructions and encoder functions.

This commit added new information about how to add support for a new
instruction in the Jas assembler, however, this commit only descitbes
the changes for adding the instruction encoder reference table aka
the `insr_encode_table_t` as seen in `instruction.h` and the corri-
sponding source file
This commit fixed spelling errors and beautified code example on  the instruction encoder table as well as the formatting of the explanation caption for the corresponding example code.
Squash 3 commits with similar published changes
This commit added a new section into the contributions guide, this
section explained the steps and implications involved to add a
instruction to the `instructions` enum after defining the struct
This comit added the code section termination symbol to terminate
the demo code, since the termination symbol was forgotten in previous
commit number  b9e87d1
In markdown, if there are whitesapces before and/or after the bold
operator - `**`, the formatting will be omitted for some reason :((
This commit shows the final changes that has finished the 'Adding s-
upport for a new instruction to the assembler' section.
This commit added rthe maintaince section that explained how the
maintaince works as a team in the Jas project as well as how they
can become and renouce maintainer status
Added previously missing link for maintainers which was added in commit number d1e79dc
This commit added the section for explaining how to contribute
a new encoder to the Jas assembler.
@cheng-alvin cheng-alvin added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 23, 2024
@cheng-alvin cheng-alvin merged commit d8e7f65 into main Dec 23, 2024
3 checks passed
@cheng-alvin cheng-alvin deleted the contributing-guide-changes branch December 24, 2024 23:47
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
None yet
Development

Successfully merging this pull request may close these issues.

1 participant