Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Iris
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Terraform modules
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
William Mansky
Iris
Commits
e58cd282
Commit
e58cd282
authored
6 years ago
by
Ralf Jung
Browse files
Options
Downloads
Patches
Plain Diff
move everything contribution-related to CONTRIBUTING.md, and link to it from README
parent
455fec93
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
CONTRIBUTING.md
+42
-7
42 additions, 7 deletions
CONTRIBUTING.md
README.md
+3
-30
3 additions, 30 deletions
README.md
with
45 additions
and
37 deletions
CONTRIBUTING.md
+
42
−
7
View file @
e58cd282
...
...
@@ -5,12 +5,47 @@ Discussion about the Iris Coq development happens on the mailing list
in the
[
Iris Chat
](
https://mattermost.mpi-sws.org/iris
)
. This is also the right
place to ask questions. The chat requires an account at the
[
MPI-SWS GitLab
](
https://gitlab.mpi-sws.org/users/sign_in
)
(
use
the "Register"
tab).
If you want to report a bug, please use the
tab). If you want to report a bug, please use the
[
issue tracker
](
https://gitlab.mpi-sws.org/FP/iris-coq/issues
)
, which also
requires an MPI-SWS GitLab account. To contribute code, please send your
MPI-SWS GitLab username to
[
Ralf Jung
](
https://gitlab.mpi-sws.org/jung
)
to
enable personal projects for your account. Then you can fork the
requires an MPI-SWS GitLab account.
Below, you can find some useful resources and an FAQ.
*
Information on how to set up your editor for unicode input and output is
collected in
[
Editor.md
](
Editor.md
)
.
*
The Iris Proof Mode (IPM) / MoSeL is documented at
[
ProofMode.md
](
ProofMode.md
)
.
*
Naming conventions are documented at
[
Naming.md
](
Naming.md
)
.
## How to submit a pull request
To contribute code, please send your MPI-SWS GitLab username to
[
Ralf Jung
](
https://gitlab.mpi-sws.org/jung
)
to enable personal projects for
your account. Then you can fork the
[
Iris git repository
](
https://gitlab.mpi-sws.org/FP/iris-coq/
)
, make your
changes in your fork, and create a merge request.
changes in your fork, and create a merge request. Please do
*not*
use the
master branch of your fork, that might confuse CI. Use a feature branch
instead.
## How to update the std++ dependency
*
Do the change in std++, push it.
*
Wait for CI to publish a new std++ version on the opam archive, then run
`opam update iris-dev`
.
*
In Iris, change the
`opam`
file to depend on the new version.
*
Run
`make build-dep`
(in Iris) to install the new version of std++.
You may have to do
`make clean`
as Coq will likely complain about .vo file
mismatches.
## How to write/update test cases
The files in
`tests/`
are test cases. Each of the
`.v`
files comes with a
matching
`.ref`
file containing the expected output of
`coqc`
. Adding
`Show.`
in selected places in the proofs makes
`coqc`
print the current goal state.
This is used to make sure the proof mode prints goals and reduces terms the way
we expect it to. You can run
`MAKE_REF=1 make`
to re-generate all the
`.ref`
files;
this is useful after adding or removing
`Show.`
from a test. If you do this,
make sure to check the diff for any unexpected changes in the output!
Some test cases have per-Coq-version
`.ref`
files (e.g.,
`atomic.8.8.ref`
is a
Coq-8.8-specific
`.ref`
file). If you change one of these, remember to update
*all*
the
`.ref`
files.
This diff is collapsed.
Click to expand it.
README.md
+
3
−
30
View file @
e58cd282
...
...
@@ -108,33 +108,6 @@ that should be compatible with this version:
*
[
Iris Atomic
](
https://gitlab.mpi-sws.org/FP/iris-atomic/
)
is an experimental
formalization of logically atomic triples in Iris.
## Notes for Iris Developers
*
Information on how to set up your editor for unicode input and output is
collected in
[
Editor.md
](
Editor.md
)
.
*
The Iris Proof Mode (IPM) / MoSeL is documented at
[
ProofMode.md
](
ProofMode.md
)
.
*
Naming conventions are documented at
[
Naming.md
](
Naming.md
)
.
### How to update the std++ dependency
*
Do the change in std++, push it.
*
Wait for CI to publish a new std++ version on the opam archive, then run
`opam update iris-dev`
.
*
In Iris, change the
`opam`
file to depend on the new version.
*
Run
`make build-dep`
(in Iris) to install the new version of std++.
You may have to do
`make clean`
as Coq will likely complain about .vo file
mismatches.
### How to write/update test cases
The files in
`tests/`
are test cases. Each of the
`.v`
files comes with a
matching
`.ref`
file containing the expected output of
`coqc`
. Adding
`Show.`
in selected places in the proofs makes
`coqc`
print the current goal state.
This is used to make sure the proof mode prints goals and reduces terms the way
we expect it to. You can run
`MAKE_REF=1 make`
to re-generate all the
`.ref`
files;
this is useful after adding or removing
`Show.`
from a test. If you do this,
make sure to check the diff for any unexpected changes in the output!
Some test cases have per-Coq-version
`.ref`
files (e.g.,
`atomic.8.8.ref`
is a
Coq-8.8-specific
`.ref`
file). If you change one of these, remember to update
*all*
the
`.ref`
files.
## Notes for Iris Contributors
See the
[
contribution guide
](
CONTRIBUTING.md
)
.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment