Skip to content

Commit

Permalink
Add changelog and contribution guide
Browse files Browse the repository at this point in the history
* Add CONTRIBUTING.md, ISSUE_TEMPLATE.md and PULL_REQUEST_TEMPLATE.md [ci skip]
* Add a CHANGELOG.md
  • Loading branch information
robertodr authored and arnfinn committed Apr 7, 2017
1 parent d955f8b commit 90516c3
Show file tree
Hide file tree
Showing 4 changed files with 156 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# How to contribute

We welcome contributions from external contributors, and this document
describes how to merge code changes into ddPCM.
Our contribution guide is based on [Psi4 contribution guide](https://github.com/psi4/psi4/blob/master/.github/CONTRIBUTING.md)

## Getting Started

* Make sure you have a [GitHub account](https://github.com/signup/free).
* [Fork](https://help.github.com/articles/fork-a-repo/) the
[PCMSolver/ddPCM](https://github.com/PCMSolver/ddPCM) repository on GitHub.
* On your local machine,
[clone](https://help.github.com/articles/cloning-a-repository/) your fork of
the ddPCM repository.

## Making Changes

* Add some really awesome code to your local fork. It's usually a [good
idea](http://blog.jasonmeridth.com/posts/do-not-issue-pull-requests-from-your-master-branch/)
to make changes on a
[branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/)
with the branch name relating to the feature you are going to add.
* When you are ready for others to examine and comment on your new feature,
navigate to your fork of ddPCM on GitHub and open a
[pull request](https://help.github.com/articles/using-pull-requests/) (PR)
__towards the `master` branch__.
Note that after you launch a PR from one of your fork's branches, all
subsequent commits to that branch will be added to the open pull request
automatically.
Each commit added to the PR will be validated for mergability, compilation
and test suite compliance; the results of these tests will be visible on the
PR page.
* If you're providing a new feature, you must add test cases, documentation and
update the `CHANGELOG.md` file.
* When the code is ready to go, make sure you run the full or relevant portion
of the test suite on your local machine to check that nothing is broken.
* When you're ready to be considered for merging, check the "Ready to go" box
on the PR page to let the ddPCM team know that the changes are complete.
The code will not be merged until this box is checked, the continuous
integration (Travis for Linux and Mac) returns checkmarks, and multiple core
developers give "Approved" reviews.

## Licensing

We do not require any formal copyright assignment or contributor license
agreement.
**Any contributions intentionally sent upstream are presumed to be offered under
terms of the OSI-approved LGPLv3 License.**

# Additional Resources

* [General GitHub documentation](https://help.github.com/)
* [PR best practices](http://codeinthehole.com/writing/pull-requests-and-other-good-practices-for-teams-using-github/)
* [A guide to contributing to software packages](http://www.contribution-guide.org)
* [Thinkful PR example](http://www.thinkful.com/learn/github-pull-request-tutorial/#Time-to-Submit-Your-First-PR)
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!--- Provide a general summary of the issue in the Title above -->
<!--- Use labels to help the developers -->
<!--- Remove the unnecessary sections when filing -->

## Expected Behavior
<!--- If you're describing a bug, tell us what should happen -->
<!--- If you're suggesting a change/improvement, tell us how it should work -->

## Current Behavior
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
<!--- If suggesting a change/improvement, explain the difference from current behavior -->

## Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
<!--- or ideas how to implement the addition or change -->

## Steps to Reproduce (for bugs)
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.

## Context
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

## Your Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
* Version used:
* Environment name and version (e.g. PHP 5.4 on nginx 1.9.1):
* Server type and version:
* Operating System and version:
* Link to your project:
42 changes: 42 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!--- Provide a general summary of your changes in the Title above -->
<!--- Use labels to help the developers -->
<!--- Remove the unnecessary sections when filing -->

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):

## Todos
<!--- Notable points that this PR has either accomplished or will accomplish. -->
* **Developer Interest**
<!--- Changes affecting developers -->
- [ ] Feature1
* **User-Facing for Release Notes**
<!--- Changes affecting users -->
- [ ] Feature2

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Questions
<!--- Questions to the developers -->
- [ ] Question1

## Status
<!--- Check this box when ready to be merged -->
- [ ] Ready to go


24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Change Log

## [Unreleased]

### Added

- [CMake] build system _via_ [Autocmake]. CMake 3.3 is the minimum required version.

[CMake]: https://cmake.org/
[Autocmake]: http://autocmake.readthedocs.io/en/latest/

### Changed

### Deprecated

### Removed

### Fixed

### Security

[Unreleased]: https://github.com/PCMSolver/ddPCM

[GitHub]: https://github.com/PCMSolver/ddPCM

0 comments on commit 90516c3

Please sign in to comment.