Skip to content

Docs: added CONTRIBUTING.md and DEVELOPING.md #164

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
ahelwer merged 1 commit into from
Feb 28, 2025
Merged

Docs: added CONTRIBUTING.md and DEVELOPING.md #164

ahelwer merged 1 commit into from
Feb 28, 2025

Conversation

@ahelwer
Copy link
Collaborator

@ahelwer ahelwer commented Feb 27, 2025 •
edited
Loading

Changes:

  • Add notes to README.md about how to usefully query the manifest.json file for various features (I especially often use this for advanced model file features like ALIAS and such)
  • Move contributing instructions from README.md to standalone CONTRIBUTING.md for greater detail; emphasize the possibility of using .ciignore
  • Document all the CI scripts and how to run them in DEVELOPING.md, along with how to consume this repo in your own project
  • Noticed the record_model_state_space.py script was broken so I fixed it

muenchnerkindl
muenchnerkindl approved these changes Feb 28, 2025
View reviewed changes
Copy link
Collaborator

@muenchnerkindl muenchnerkindl left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@ahelwer ahelwer force-pushed the docs branch 3 times, most recently from 345aaba to 041b058 Compare February 28, 2025 16:11
@ahelwer
Docs: added CONTRIBUTING.md and DEVELOPING.md
48cea32 
These expand on the steps necessary to contribute a spec to this repo,
or use/extend the CI validation scripts.

Signed-off-by: Andrew Helwer <[email protected]>
@ahelwer ahelwer merged commit 8c5d3fb into tlaplus:master Feb 28, 2025
7 checks passed
@ahelwer ahelwer deleted the docs branch February 28, 2025 17:15
@ahelwer ahelwer mentioned this pull request May 21, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@muenchnerkindl muenchnerkindl muenchnerkindl approved these changes

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ahelwer @muenchnerkindl