Merge pull request #579 from alicevision/github/templates

[github] add issue templates

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[bug]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Log**
+If applicable, copy paste the relevant log output (please embed the text in a markdown code tag "```" )
+
+**Desktop (please complete the following and other pertinent information):**
+ - OS: [e.g. win 10, osx, ]
+ - Version [e.g. 2019.1]
+ - Python version [e.g. 2.6]
+ - Qt/PySide version [e.g. 5.12.4]
+ - Binary version (if applicable) [e.g. 2019.1]
+ - Commit reference (if applicable) [e.g. 08ddbe2]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[request]"
+labels: feature request
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,29 @@
+<!-- Checklist before submission:
+
+ - I have read the [contribution guidelines](../CONTRIBUTING.md).
+ - I have updated the documentation, if applicable.
+ - I have ensured that the change is tested somewhere.
+ - I have followed the prevailing code style (for history readability and limit conflicts for maintainance).
+
+-->
+## Description
+
+
+
+## Features list
+
+<!--
+- [ ] Feature one. Fix #XXX
+- [ ] Improve something else
+- [ ] Connect to #3 (to declare link to issues without closing it when the PR is merged).
+- [X] Add "X" when it is done.
+-->
+
+
+## Implementation remarks
+
+
+<!--
+Explain main implementation choices.
+It is also the right place to ask for feedback and help when you hesitate on the implementation.
+-->

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team privately at alicevision-team@googlegroups.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct/
+
+[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+Contributing to Meshroom
+===========================
+
+Meshroom relies on a friendly and community-driven effort to create an open source photogrammetry solution.
+In order to foster a friendly atmosphere where technical collaboration can flourish,
+we recommend you to read the [code of conduct](CODE_OF_CONDUCT.md).
+
+
+Contributing Workflow
+---------------------
+
+The contributing workflow relies on [Github Pull Requests](https://help.github.com/articles/using-pull-requests/).
+
+1. If it is an important change, we recommend you to discuss it on the mailing-list
+before starting implementation. This ensure that the development is aligned with other
+developpements already started and will be efficiently integrated.
+
+2. Create the corresponding issues.
+
+3. Create a branch and [draft a pull request](https://github.blog/2019-02-14-introducing-draft-pull-requests/) "My new feature" so everyone can follow the development.
+Explain the implementation in the PR description with links to issues.
+
+4. Implement the new feature(s). Add unit test if needed.
+One feature per PR is ideal for review, but linked features can be part of the same PR.
+
+5. When it is ready for review, [mark the pull request as ready for review](https://help.github.com/en/articles/changing-the-stage-of-a-pull-request).
+
+6. The reviewers will look over the code and ask for changes, explain problems they found,
+congratulate the author, etc. using the github comments.
+
+7. After approval, one of the developers with commit approval to the official main repository
+will merge your fixes into the "develop" branch.

README.md

@@ -1,5 +1,7 @@
 # ![Meshroom - 3D Reconstruction Software](/docs/logo/banner-meshroom.png)
 
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2997/badge)](https://bestpractices.coreinfrastructure.org/projects/2997)
+
 Meshroom is a free, open-source 3D Reconstruction Software based on the [AliceVision](https://github.com/alicevision/AliceVision) Photogrammetric Computer Vision framework.
 
 Learn more details about the pipeline on [AliceVision website](http://alicevision.github.io).