Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
J
jscoq-light
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
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
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Pierre Rousselin
jscoq-light
Commits
3fc4d264
Unverified
Commit
3fc4d264
authored
6 years ago
by
Emilio Jesus Gallego Arias
Browse files
Options
Downloads
Patches
Plain Diff
[doc] Add contributing guidelines.
parent
6aad16eb
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
CONTRIBUTING.md
+45
-0
45 additions, 0 deletions
CONTRIBUTING.md
README.md
+0
-10
0 additions, 10 deletions
README.md
with
45 additions
and
10 deletions
CONTRIBUTING.md
0 → 100644
+
45
−
0
View file @
3fc4d264
## Contributing to jsCoq
Thanks for willing to contribute to jsCoq! Contributing is as easy as
opening a pull request, issue, or dropping by the Gitter channel and
talking to us.
### Coding style
Nothing very special has to be kept in mind, we follow standard OCaml
practice, with
`ocp-indent`
and
`ocamlformat`
indentation guidelines,
but we are liberal in some places, in particular with regards to
intra-line indentation. We compile with a very strict set of warnings.
### Review and merge guidelines
We recommend that most non-trivial changes take place using pull
requests. Any contributor can merge a pull request [including their
own] provide the pull request:
-
has updated the
`CHANGES.md`
file,
-
passes Travis CI,
-
has at least one approving review from other contributor.
Exceptions to this rule is when a review cannot happen due to lack of
a second contributor with that particular expertise.
We prefer GPG signed commits as well as
`Signed-off-by`
commits.
### Commit tag conventions [work in progress]:
We have some [soft] commit tag conventions:
-
[jscoq]: ML/Coq interface
-
[ui]: Html/Css commit
-
[cm]: CodeMirror provider
-
[libs]: Coq Library support and format
-
[doc]: Documentation
-
[addons]: Addons support
-
[build]: Build system
-
[feature]: Adding a new feature
-
[bugfix]: Bug fix
-
[refactor]: Refactoring commit (no functional change intended)
-
[ci] / [travis]: Continuous integration
-
[test]: Adding or modifying a test
-
[misc]: Miscellanenous small things
This diff is collapsed.
Click to expand it.
README.md
+
0
−
10
View file @
3fc4d264
...
...
@@ -372,16 +372,6 @@ internal data structures, but this effort has been split to an
independent development. See https://github.com/ejgallego/coq-serapi
for more information.
## Commit tag conventions [work in progress]:
-
[jscoq]: ML/Coq interface.
-
[ui]: Html/Css commit
-
[cm]: CodeMirror provider.
-
[libs]: Coq Library support and format.
-
[doc]: Documentation.
-
[addons]: Addons support.
-
[build]: Build system.
## Documents
See the
`etc/notes/`
directory for some random notes about the project.
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