{"action":"created","comment":{"url":"https://api.github.com/repos/math-comp/math-comp/pulls/comments/153218766","pull_request_review_id":79190850,"id":153218766,"diff_hunk":"@@ -0,0 +1,78 @@\n+# Contribution Guide for the Mathematical Components library\n+\n+We describe here best practices for contributing to the library. In\n+particular we explain what conventions are used in the library. When\n+contributing, you should comply to these conventions to get your code\n+integrated to the library.\n+\n+This file is not comprehensive yet and might still contain mistakes or\n+unclear indications, please consider contributing.\n+\n+## Proof style.\n+### General guidelines\n+- **A line should have no more than 80 characters**. If a line is\n+longer than that, it should be cut semantically. If there is no way to\n+make a semantic cut (e.g. the user provides an explicit term that is\n+too long to fit on one line), then just cut it over several lines to\n+make it readable.\n+- Lines end with a point `.` and only have `;` inside them.\n+- Lines that close a goal must start with a terminator (`by` or\n+  `exact`). You should consider using an editor that highlight those\n+  terminators in a specific color (e.g. red).\n+\n+### Spaces\n+We write\n+- `move=>` and `move:` (no space between `move` and `=>` or `:`)\n+- `apply/` and `apply:` (no space between `apply` and `/` or `:`)\n+- `rewrite /definition` (there is a space between `rewrite` and an unfold)\n+\n+### Indentation in proof scripts\n+- When two subgoals are created, the first subgoal is indented by 2\n+  spaces, the second is not. Use `last first` to bring the\n+  smallest/less meaningful goal first, and keep the main flow of the\n+  proof unindented.\n+- When more than two subgoals are created, bullets are used `-` for\n+  the first level, `+` for the second and `*` for the third as in:\n+  ```\n+  tactic.\n+  - tactic.\n+    + tactic.\n+      * tactic.\n+      * tactic.\n+      * tactic.\n+    + tactic.\n+    + tactic.\n+  - tactic\n+  - tactic\n+  ```\n+\n+  If all the subgoals have the same importance, use bullets for all of\n+  them, however, if one goal is more important than the others\n+  (i.e. is main flow of the proof). Then you might remove the bullet\n+  for this last one and unindent it as in:\n+  ```\n+  tactic.\n+  - tactic. (* secondary subgoal 1 *)\n+  - tactic. (* secondary subgoal 2 *)\n+  tactic. (* third subgoal is the main one *)\n+  ```\n+\n+## Statements of lemmas, theorems and definitions.\n+\n+- Universal quantifications with dependent variable should appear on the left hand side of the colon, until we reach the first non dependent variable. e.g.\n+  `Lemma example x y : x < y -> x >= y = false`\n+\n+### Term style.\n+- Operators are surrounded by space, for example `n*m` should be written `n * m`.\n+This particular example can be problematic if matrix.v is imported because then, `M *m N` is matrix product.\n+\n+### Naming of variables\n+- Variable names follow the following conventions.\n+  + Hypothesis should not be named `H`, `H'`,... (these collide with\n+  subgroup variable conventions) but have meaningful names. For\n+  example, an hypothesis `n > 0` should be named `n_gt0`.\n+  + Induction Hypothesies are prefixed by `IH` or `ih` (e.g. induction hypothesis on `n` is called `IH`).\n+  + Natural numbers and integers should be names `m`, `n`, `p`, `d`, ...","path":"CONTRIBUTING.md","position":75,"original_position":75,"commit_id":"6b25220e33cd141a3fc219e31f7251c0ee47fae7","original_commit_id":"6b25220e33cd141a3fc219e31f7251c0ee47fae7","user":{"login":"ybertot","id":3407333,"avatar_url":"https://avatars2.githubusercontent.com/u/3407333?v=4","gravatar_id":"","url":"https://api.github.com/users/ybertot","html_url":"https://github.com/ybertot","followers_url":"https://api.github.com/users/ybertot/followers","following_url":"https://api.github.com/users/ybertot/following{/other_user}","gists_url":"https://api.github.com/users/ybertot/gists{/gist_id}","starred_url":"https://api.github.com/users/ybertot/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ybertot/subscriptions","organizations_url":"https://api.github.com/users/ybertot/orgs","repos_url":"https://api.github.com/users/ybertot/repos","events_url":"https://api.github.com/users/ybertot/events{/privacy}","received_events_url":"https://api.github.com/users/ybertot/received_events","type":"User","site_admin":false},"body":"should be name**d**","created_at":"2017-11-27T14:56:36Z","updated_at":"2017-11-27T14:58:49Z","html_url":"https://github.com/math-comp/math-comp/pull/162#discussion_r153218766","pull_request_url":"https://api.github.com/repos/math-comp/math-comp/pulls/162","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/math-comp/math-comp/pulls/comments/153218766"},"html":{"href":"https://github.com/math-comp/math-comp/pull/162#discussion_r153218766"},"pull_request":{"href":"https://api.github.com/repos/math-comp/math-comp/pulls/162"}}},"pull_request":{"url":"https://api.github.com/repos/math-comp/math-comp/pulls/162","id":154556151,"html_url":"https://github.com/math-comp/math-comp/pull/162","diff_url":"https://github.com/math-comp/math-comp/pull/162.diff","patch_url":"https://github.com/math-comp/math-comp/pull/162.patch","issue_url":"https://api.github.com/repos/math-comp/math-comp/issues/162","number":162,"state":"open","locked":false,"title":"Draft contributing guide","user":{"login":"CohenCyril","id":298705,"avatar_url":"https://avatars2.githubusercontent.com/u/298705?v=4","gravatar_id":"","url":"https://api.github.com/users/CohenCyril","html_url":"https://github.com/CohenCyril","followers_url":"https://api.github.com/users/CohenCyril/followers","following_url":"https://api.github.com/users/CohenCyril/following{/other_user}","gists_url":"https://api.github.com/users/CohenCyril/gists{/gist_id}","starred_url":"https://api.github.com/users/CohenCyril/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/CohenCyril/subscriptions","organizations_url":"https://api.github.com/users/CohenCyril/orgs","repos_url":"https://api.github.com/users/CohenCyril/repos","events_url":"https://api.github.com/users/CohenCyril/events{/privacy}","received_events_url":"https://api.github.com/users/CohenCyril/received_events","type":"User","site_admin":false},"body":"","created_at":"2017-11-24T14:09:43Z","updated_at":"2017-11-27T14:58:49Z","closed_at":null,"merged_at":null,"merge_commit_sha":"056db80d26b1a0ec230fb7b614c1c8dfef1674c2","assignee":null,"assignees":[],"requested_reviewers":[],"milestone":null,"commits_url":"https://api.github.com/repos/math-comp/math-comp/pulls/162/commits","review_comments_url":"https://api.github.com/repos/math-comp/math-comp/pulls/162/comments","review_comment_url":"https://api.github.com/repos/math-comp/math-comp/pulls/comments{/number}","comments_url":"https://api.github.com/repos/math-comp/math-comp/issues/162/comments","statuses_url":"https://api.github.com/repos/math-comp/math-comp/statuses/6b25220e33cd141a3fc219e31f7251c0ee47fae7","head":{"label":"CohenCyril:CONTRIBUTING","ref":"CONTRIBUTING","sha":"6b25220e33cd141a3fc219e31f7251c0ee47fae7","user":{"login":"CohenCyril","id":298705,"avatar_url":"https://avatars2.githubusercontent.com/u/298705?v=4","gravatar_id":"","url":"https://api.github.com/users/CohenCyril","html_url":"https://github.com/CohenCyril","followers_url":"https://api.github.com/users/CohenCyril/followers","following_url":"https://api.github.com/users/CohenCyril/following{/other_user}","gists_url":"https://api.github.com/users/CohenCyril/gists{/gist_id}","starred_url":"https://api.github.com/users/CohenCyril/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/CohenCyril/subscriptions","organizations_url":"https://api.github.com/users/CohenCyril/orgs","repos_url":"https://api.github.com/users/CohenCyril/repos","events_url":"https://api.github.com/users/CohenCyril/events{/privacy}","received_events_url":"https://api.github.com/users/CohenCyril/received_events","type":"User","site_admin":false},"repo":{"id":79439161,"name":"math-comp","full_name":"CohenCyril/math-comp","owner":{"login":"CohenCyril","id":298705,"avatar_url":"https://avatars2.githubusercontent.com/u/298705?v=4","gravatar_id":"","url":"https://api.github.com/users/CohenCyril","html_url":"https://github.com/CohenCyril","followers_url":"https://api.github.com/users/CohenCyril/followers","following_url":"https://api.github.com/users/CohenCyril/following{/other_user}","gists_url":"https://api.github.com/users/CohenCyril/gists{/gist_id}","starred_url":"https://api.github.com/users/CohenCyril/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/CohenCyril/subscriptions","organizations_url":"https://api.github.com/users/CohenCyril/orgs","repos_url":"https://api.github.com/users/CohenCyril/repos","events_url":"https://api.github.com/users/CohenCyril/events{/privacy}","received_events_url":"https://api.github.com/users/CohenCyril/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/CohenCyril/math-comp","description":"Mathematical Components","fork":true,"url":"https://api.github.com/repos/CohenCyril/math-comp","forks_url":"https://api.github.com/repos/CohenCyril/math-comp/forks","keys_url":"https://api.github.com/repos/CohenCyril/math-comp/keys{/key_id}","collaborators_url":"https://api.github.com/repos/CohenCyril/math-comp/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/CohenCyril/math-comp/teams","hooks_url":"https://api.github.com/repos/CohenCyril/math-comp/hooks","issue_events_url":"https://api.github.com/repos/CohenCyril/math-comp/issues/events{/number}","events_url":"https://api.github.com/repos/CohenCyril/math-comp/events","assignees_url":"https://api.github.com/repos/CohenCyril/math-comp/assignees{/user}","branches_url":"https://api.github.com/repos/CohenCyril/math-comp/branches{/branch}","tags_url":"https://api.github.com/repos/CohenCyril/math-comp/tags","blobs_url":"https://api.github.com/repos/CohenCyril/math-comp/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/CohenCyril/math-comp/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/CohenCyril/math-comp/git/refs{/sha}","trees_url":"https://api.github.com/repos/CohenCyril/math-comp/git/trees{/sha}","statuses_url":"https://api.github.com/repos/CohenCyril/math-comp/statuses/{sha}","languages_url":"https://api.github.com/repos/CohenCyril/math-comp/languages","stargazers_url":"https://api.github.com/repos/CohenCyril/math-comp/stargazers","contributors_url":"https://api.github.com/repos/CohenCyril/math-comp/contributors","subscribers_url":"https://api.github.com/repos/CohenCyril/math-comp/subscribers","subscription_url":"https://api.github.com/repos/CohenCyril/math-comp/subscription","commits_url":"https://api.github.com/repos/CohenCyril/math-comp/commits{/sha}","git_commits_url":"https://api.github.com/repos/CohenCyril/math-comp/git/commits{/sha}","comments_url":"https://api.github.com/repos/CohenCyril/math-comp/comments{/number}","issue_comment_url":"https://api.github.com/repos/CohenCyril/math-comp/issues/comments{/number}","contents_url":"https://api.github.com/repos/CohenCyril/math-comp/contents/{+path}","compare_url":"https://api.github.com/repos/CohenCyril/math-comp/compare/{base}...{head}","merges_url":"https://api.github.com/repos/CohenCyril/math-comp/merges","archive_url":"https://api.github.com/repos/CohenCyril/math-comp/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/CohenCyril/math-comp/downloads","issues_url":"https://api.github.com/repos/CohenCyril/math-comp/issues{/number}","pulls_url":"https://api.github.com/repos/CohenCyril/math-comp/pulls{/number}","milestones_url":"https://api.github.com/repos/CohenCyril/math-comp/milestones{/number}","notifications_url":"https://api.github.com/repos/CohenCyril/math-comp/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/CohenCyril/math-comp/labels{/name}","releases_url":"https://api.github.com/repos/CohenCyril/math-comp/releases{/id}","deployments_url":"https://api.github.com/repos/CohenCyril/math-comp/deployments","created_at":"2017-01-19T09:51:20Z","updated_at":"2017-01-19T09:51:27Z","pushed_at":"2017-11-27T13:36:19Z","git_url":"git://github.com/CohenCyril/math-comp.git","ssh_url":"git@github.com:CohenCyril/math-comp.git","clone_url":"https://github.com/CohenCyril/math-comp.git","svn_url":"https://github.com/CohenCyril/math-comp","homepage":"","size":6219,"stargazers_count":0,"watchers_count":0,"language":"Coq","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"math-comp:master","ref":"master","sha":"82739c704bef2234dce643cbdd0b5be5a79b755b","user":{"login":"math-comp","id":11424151,"avatar_url":"https://avatars2.githubusercontent.com/u/11424151?v=4","gravatar_id":"","url":"https://api.github.com/users/math-comp","html_url":"https://github.com/math-comp","followers_url":"https://api.github.com/users/math-comp/followers","following_url":"https://api.github.com/users/math-comp/following{/other_user}","gists_url":"https://api.github.com/users/math-comp/gists{/gist_id}","starred_url":"https://api.github.com/users/math-comp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/math-comp/subscriptions","organizations_url":"https://api.github.com/users/math-comp/orgs","repos_url":"https://api.github.com/users/math-comp/repos","events_url":"https://api.github.com/users/math-comp/events{/privacy}","received_events_url":"https://api.github.com/users/math-comp/received_events","type":"Organization","site_admin":false},"repo":{"id":32018344,"name":"math-comp","full_name":"math-comp/math-comp","owner":{"login":"math-comp","id":11424151,"avatar_url":"https://avatars2.githubusercontent.com/u/11424151?v=4","gravatar_id":"","url":"https://api.github.com/users/math-comp","html_url":"https://github.com/math-comp","followers_url":"https://api.github.com/users/math-comp/followers","following_url":"https://api.github.com/users/math-comp/following{/other_user}","gists_url":"https://api.github.com/users/math-comp/gists{/gist_id}","starred_url":"https://api.github.com/users/math-comp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/math-comp/subscriptions","organizations_url":"https://api.github.com/users/math-comp/orgs","repos_url":"https://api.github.com/users/math-comp/repos","events_url":"https://api.github.com/users/math-comp/events{/privacy}","received_events_url":"https://api.github.com/users/math-comp/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/math-comp/math-comp","description":"Mathematical Components","fork":false,"url":"https://api.github.com/repos/math-comp/math-comp","forks_url":"https://api.github.com/repos/math-comp/math-comp/forks","keys_url":"https://api.github.com/repos/math-comp/math-comp/keys{/key_id}","collaborators_url":"https://api.github.com/repos/math-comp/math-comp/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/math-comp/math-comp/teams","hooks_url":"https://api.github.com/repos/math-comp/math-comp/hooks","issue_events_url":"https://api.github.com/repos/math-comp/math-comp/issues/events{/number}","events_url":"https://api.github.com/repos/math-comp/math-comp/events","assignees_url":"https://api.github.com/repos/math-comp/math-comp/assignees{/user}","branches_url":"https://api.github.com/repos/math-comp/math-comp/branches{/branch}","tags_url":"https://api.github.com/repos/math-comp/math-comp/tags","blobs_url":"https://api.github.com/repos/math-comp/math-comp/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/math-comp/math-comp/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/math-comp/math-comp/git/refs{/sha}","trees_url":"https://api.github.com/repos/math-comp/math-comp/git/trees{/sha}","statuses_url":"https://api.github.com/repos/math-comp/math-comp/statuses/{sha}","languages_url":"https://api.github.com/repos/math-comp/math-comp/languages","stargazers_url":"https://api.github.com/repos/math-comp/math-comp/stargazers","contributors_url":"https://api.github.com/repos/math-comp/math-comp/contributors","subscribers_url":"https://api.github.com/repos/math-comp/math-comp/subscribers","subscription_url":"https://api.github.com/repos/math-comp/math-comp/subscription","commits_url":"https://api.github.com/repos/math-comp/math-comp/commits{/sha}","git_commits_url":"https://api.github.com/repos/math-comp/math-comp/git/commits{/sha}","comments_url":"https://api.github.com/repos/math-comp/math-comp/comments{/number}","issue_comment_url":"https://api.github.com/repos/math-comp/math-comp/issues/comments{/number}","contents_url":"https://api.github.com/repos/math-comp/math-comp/contents/{+path}","compare_url":"https://api.github.com/repos/math-comp/math-comp/compare/{base}...{head}","merges_url":"https://api.github.com/repos/math-comp/math-comp/merges","archive_url":"https://api.github.com/repos/math-comp/math-comp/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/math-comp/math-comp/downloads","issues_url":"https://api.github.com/repos/math-comp/math-comp/issues{/number}","pulls_url":"https://api.github.com/repos/math-comp/math-comp/pulls{/number}","milestones_url":"https://api.github.com/repos/math-comp/math-comp/milestones{/number}","notifications_url":"https://api.github.com/repos/math-comp/math-comp/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/math-comp/math-comp/labels{/name}","releases_url":"https://api.github.com/repos/math-comp/math-comp/releases{/id}","deployments_url":"https://api.github.com/repos/math-comp/math-comp/deployments","created_at":"2015-03-11T13:13:27Z","updated_at":"2017-11-22T13:52:29Z","pushed_at":"2017-11-27T13:36:20Z","git_url":"git://github.com/math-comp/math-comp.git","ssh_url":"git@github.com:math-comp/math-comp.git","clone_url":"https://github.com/math-comp/math-comp.git","svn_url":"https://github.com/math-comp/math-comp","homepage":"","size":6121,"stargazers_count":93,"watchers_count":93,"language":"Coq","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":28,"mirror_url":null,"archived":false,"open_issues_count":53,"forks":28,"open_issues":53,"watchers":93,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/math-comp/math-comp/pulls/162"},"html":{"href":"https://github.com/math-comp/math-comp/pull/162"},"issue":{"href":"https://api.github.com/repos/math-comp/math-comp/issues/162"},"comments":{"href":"https://api.github.com/repos/math-comp/math-comp/issues/162/comments"},"review_comments":{"href":"https://api.github.com/repos/math-comp/math-comp/pulls/162/comments"},"review_comment":{"href":"https://api.github.com/repos/math-comp/math-comp/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/math-comp/math-comp/pulls/162/commits"},"statuses":{"href":"https://api.github.com/repos/math-comp/math-comp/statuses/6b25220e33cd141a3fc219e31f7251c0ee47fae7"}},"author_association":"OWNER"}}
{"actor":{"display_login":"ybertot"}}