Skip to content

Update Repository Documentation, Issue Templates #106

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 35 commits into from
Jul 16, 2025
Merged

Update Repository Documentation, Issue Templates #106

merged 35 commits into from
Jul 16, 2025

Conversation

emnul
Copy link
Contributor

@emnul emnul commented Jun 6, 2025

Closes #49

@emnul emnul requested a review from a team as a code owner June 6, 2025 21:21
@emnul emnul changed the title Add CONTRIBUTING doc Update Repository Documentation, Issue Templates Jun 7, 2025
andrew-fleming
andrew-fleming reviewed Jun 10, 2025
View reviewed changes
Copy link
Contributor

@andrew-fleming andrew-fleming left a comment

Choose a reason for hiding this comment

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

Very nice work @emnul! I left some comments :)

emnul and others added 13 commits June 12, 2025 08:41
@emnul @andrew-fleming
Reword sentence in SUPPORT.md
fb743fc 
Co-authored-by: Andrew Fleming <[email protected]>
Signed-off-by: ⟣ €₥ℵ∪ℓ ⟢ <[email protected]>
@emnul
Distinguish code review requirements for small vs large code changes
f938bbe
@emnul
Remove Compact conventions section and create issue for tracking
c8beb53
@emnul @andrew-fleming
Fix broken link
bef1f5e 
Co-authored-by: Andrew Fleming <[email protected]>
Signed-off-by: ⟣ €₥ℵ∪ℓ ⟢ <[email protected]>
@emnul @andrew-fleming
Fix formatting
8ee6b1d 
Co-authored-by: Andrew Fleming <[email protected]>
Signed-off-by: ⟣ €₥ℵ∪ℓ ⟢ <[email protected]>
@emnul @andrew-fleming
fix formatting
1a81d00 
Co-authored-by: Andrew Fleming <[email protected]>
Signed-off-by: ⟣ €₥ℵ∪ℓ ⟢ <[email protected]>
@emnul @andrew-fleming
Update heading level
6b6c140 
Co-authored-by: Andrew Fleming <[email protected]>
Signed-off-by: ⟣ €₥ℵ∪ℓ ⟢ <[email protected]>
@emnul @andrew-fleming
Use asterisks for bullet points, end with periods
b190c49 
Co-authored-by: Andrew Fleming <[email protected]>
Signed-off-by: ⟣ €₥ℵ∪ℓ ⟢ <[email protected]>
@emnul @andrew-fleming
Format CONTRIBUTING.md
bd915c1 
Co-authored-by: Andrew Fleming <[email protected]>
Signed-off-by: ⟣ €₥ℵ∪ℓ ⟢ <[email protected]>
@emnul
One sentence per line
aa4d486
@emnul @andrew-fleming
Add more detail to TypeScript code quality tooling
df29b36 
Co-authored-by: Andrew Fleming <[email protected]>
Signed-off-by: ⟣ €₥ℵ∪ℓ ⟢ <[email protected]>
@emnul
Split long line into smaller lines
1eeab23
@emnul
Update Code Style Section
e4938c7
@emnul emnul requested a review from andrew-fleming June 13, 2025 17:32
andrew-fleming
andrew-fleming reviewed Jun 15, 2025
View reviewed changes
Copy link
Contributor

@andrew-fleming andrew-fleming left a comment

Choose a reason for hiding this comment

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

Very good improvements! I left a few tiny suggestions and a question. Otherwise, I think we should be good to go!

GUIDELINES.md Outdated

Method documentation must list all requirements necessary for the method to execute without error.

All changes to the core codebase (excluding tests, auxiliary scripts, etc.) must be documented in a changelog, except for purely cosmetic or documentation changes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Another when applicable candidate until we have a changelog

@emnul emnul requested a review from andrew-fleming July 15, 2025 02:14
andrew-fleming
andrew-fleming reviewed Jul 15, 2025
View reviewed changes
Copy link
Contributor

@andrew-fleming andrew-fleming left a comment

Choose a reason for hiding this comment

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

Small issue, we need to update the referenced repo name and links: contracts for midnight -> contracts for compact. I suggested a few changes; however, there's a few more in CONTRIBUTING

Then we're good to go

emnul
emnul commented Jul 15, 2025
View reviewed changes
@emnul emnul requested a review from andrew-fleming July 15, 2025 20:04
andrew-fleming
andrew-fleming approved these changes Jul 15, 2025
View reviewed changes
Copy link
Contributor

@andrew-fleming andrew-fleming left a comment

Choose a reason for hiding this comment

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

LGTM!

@emnul emnul merged commit cfe695e into main Jul 16, 2025
7 checks passed
@emnul emnul deleted the add-contributing-guidelines branch August 28, 2025 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@andrew-fleming andrew-fleming andrew-fleming approved these changes

Assignees

@emnul emnul

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING doc

2 participants

@emnul @andrew-fleming