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 some contributor/developer guidelines #5399

Merged
merged 2 commits into from
Jan 10, 2024

Conversation

fingolfin
Copy link
Member

@fingolfin fingolfin commented Mar 8, 2023

Some time ago I started work on some developer guidelines. I can't seem to find time to complete them, so I thought perhaps I should just post them anyway: better to have something incomplete than have nothing... And I also won't as easily forget about this.

Feedback, additions, improvements welcome.

This is meant to eventually address issue #3381 and perhaps others.

Resolves #2254
Resolves #2721

@fingolfin fingolfin added topic: documentation Issues and PRs related to documentation release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes topic: workflow Meta: anything related to the development workflow of GAP labels Mar 8, 2023
@fingolfin fingolfin closed this Mar 14, 2023
@fingolfin fingolfin reopened this Mar 14, 2023
@fingolfin fingolfin force-pushed the mh/developer-guidelines branch 4 times, most recently from c45ba21 to 102211d Compare January 8, 2024 14:45
@fingolfin fingolfin changed the title Add some developer guidelines Add some contributor/developer guidelines Jan 8, 2024
@fingolfin fingolfin marked this pull request as ready for review January 9, 2024 15:02
@fingolfin
Copy link
Member Author

I am sure this can still be improved a lot, but it seems much better than what we have right now (i.e., nothing), so perhaps let's just merge it?

Copy link
Contributor

@james-d-mitchell james-d-mitchell left a comment

Choose a reason for hiding this comment

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

Looks good other than a number of minor typos which I've suggested fixes for.

DEVELOPING.md Outdated Show resolved Hide resolved
DEVELOPING.md Outdated Show resolved Hide resolved
DEVELOPING.md Outdated Show resolved Hide resolved
DEVELOPING.md Outdated Show resolved Hide resolved
DEVELOPING.md Outdated Show resolved Hide resolved
DEVELOPING.md Outdated Show resolved Hide resolved
DEVELOPING.md Outdated Show resolved Hide resolved
DEVELOPING.md Outdated Show resolved Hide resolved
DEVELOPING.md Outdated Show resolved Hide resolved
DEVELOPING.md Outdated Show resolved Hide resolved
Co-authored-by: James Mitchell <james-d-mitchell@users.noreply.github.com>
@fingolfin
Copy link
Member Author

Thanks @james-d-mitchell all applied

Copy link
Contributor

@james-d-mitchell james-d-mitchell left a comment

Choose a reason for hiding this comment

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

Looks good!

@fingolfin fingolfin merged commit da64791 into gap-system:master Jan 10, 2024
22 checks passed
@fingolfin fingolfin deleted the mh/developer-guidelines branch January 10, 2024 09:44
- `testbugfix`: additional small test files that are created to verify
specific bugfixes work as intended
Run via `./gap tst/testbugfix.g`
- `testinstall`: quick test suite that one can test frequently.
Copy link
Contributor

Choose a reason for hiding this comment

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

Item is duplicate of first item

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes topic: documentation Issues and PRs related to documentation topic: workflow Meta: anything related to the development workflow of GAP
Projects
None yet
3 participants