generated from OS2offdig/os2-project-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 6abec74
Showing
10 changed files
with
610 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
#Gitignore file | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Thank you! – everyone that help! | ||
|
||
In this document we recommend writing a little about how the project was created and pay tribute to the contributors. | ||
|
||
Here is a list of MUCH-APPRECIATED CONTRIBUTORS -- | ||
people who laid the groundwork, have written code, reported bugs, added | ||
documentation, helped answer questions, and generally made **OS2produkt** that much | ||
better: | ||
|
||
* John Doe | ||
* Jane Doe | ||
* Billy Idol | ||
|
||
A big THANK YOU goes to: | ||
|
||
All municipalities who initiated the project: LIST NAMES here. | ||
|
||
**Maybe mention the vendors** for their excellent guidance and support. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# Change Log in OS2 projects/products | ||
|
||
All notable changes to the project MUST be documented in this file. | ||
|
||
The format can be based on [Keep a Changelog](http://keepachangelog.com/) | ||
and the project versioning could adher to [Semantic Versioning](http://semver.org/). | ||
|
||
## Guiding Principles | ||
|
||
* Changelogs are for humans, not machines. | ||
* There should be an entry for every single version. | ||
* The same types of changes should be grouped. | ||
* Versions and sections should be linkable. | ||
* The latest version comes first. | ||
* The release date of each version is displayed. | ||
* Mention whether you follow Semantic Versioning. | ||
|
||
## Types of changes | ||
|
||
* Added for new features. | ||
* Changed for changes in existing functionality. | ||
* Deprecated for soon-to-be removed features. | ||
* Removed for now removed features. | ||
* Fixed for any bug fixes. | ||
* Security in case of vulnerabilitie | ||
|
||
# Example | ||
|
||
## [Unreleased] - yyyy-mm-dd | ||
|
||
Here we write upgrading notes for brands. It's a team effort to make them as | ||
straightforward as possible. | ||
|
||
### Added | ||
- [PROJECTNAME-XXXX](http://tickets.projectname.com/browse/PROJECTNAME-XXXX) | ||
MINOR Ticket title goes here. | ||
- [PROJECTNAME-YYYY](http://tickets.projectname.com/browse/PROJECTNAME-YYYY) | ||
PATCH Ticket title goes here. | ||
|
||
### Changed | ||
|
||
### Fixed | ||
|
||
## [1.2.4] - 2017-03-15 | ||
|
||
Here we would have the update steps for 1.2.4 for people to follow. | ||
|
||
### Added | ||
|
||
### Changed | ||
|
||
- [PROJECTNAME-ZZZZ](http://tickets.projectname.com/browse/PROJECTNAME-ZZZZ) | ||
PATCH Drupal.org is now used for composer. | ||
|
||
### Fixed | ||
|
||
- [PROJECTNAME-TTTT](http://tickets.projectname.com/browse/PROJECTNAME-TTTT) | ||
PATCH Add logic to runsheet teaser delete to delete corresponding | ||
schedule cards. | ||
|
||
## [1.2.3] - 2017-03-14 | ||
|
||
### Added | ||
|
||
### Changed | ||
|
||
### Fixed | ||
|
||
- [PROJECTNAME-UUUU](http://tickets.projectname.com/browse/PROJECTNAME-UUUU) | ||
MINOR Fix module foo tests | ||
- [PROJECTNAME-RRRR](http://tickets.projectname.com/browse/PROJECTNAME-RRRR) | ||
MAJOR Module foo's timeline uses the browser timezone for date resolution |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Code of Conduct | ||
|
||
In the interest of fostering an open and welcoming environment we pledge to making participation in our project and our community a harassment-free experience for everyone. | ||
|
||
Please refer to the general [Code of Conduct for OS2](https://os2.eu/side/code-conduct) | ||
|
||
If the project is in need of a project specific CoC you can refer to [ontributor Covenant](https://www.contributor-covenant.org/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Make contributing easy | ||
|
||
It's important that it is very clear how you can become involved and contribute to a project. | ||
|
||
Therefor: | ||
|
||
* The project MUST have a public issue tracker that accepts suggestions from anyone. In OS2 we use [Jira](https://os2web.atlassian.net/) but a combination with for example Github issues are also okay. | ||
* The project MUST include instructions for how to privately report security issues for responsible disclosure. This can be covered by the [SECURITY](SECURITY.md) file. | ||
* The documentation MUST link to both the public issue tracker and submitted codebase changes, for example in a README file. | ||
* The project MUST have communication channels for users and developers. In OS2 we provide the tools to communicate through email lists and our main website. | ||
* The documentation SHOULD include instructions for how to report potentially security sensitive issues on a closed channel. | ||
|
||
# Example | ||
|
||
# Contribution guidelines for *OS2produkt* | ||
|
||
If you want to contribute to *OS2produkt*, we ask you to follow these guidelines. | ||
|
||
## Reporting bugs | ||
If you have encountered a bug in *OS2produkt*, please check if an issue already exists in the list of existing [issues](https://os2web.atlassian.net/), if such an issue does not exist, you can create one [here](https://os2web.atlassian.net/). When writing the bug report, try to add a clear example that shows how to reproduce said bug. | ||
|
||
## Adding new features | ||
Before making making changes to the code, we advise you to first check the list of existing [issues](https://os2web.atlassian.net/) for OS2produkt to see if an issue for the suggested changes already exists. If such an issue does not exist, you can create one [here](https://os2web.atlassian.net/). Creating an issue gives an opportunity for other developers to give tips even before you start coding. If you are in the early idea phase, or if your feature requires larger changes, you can discuss it with the [projects coordination group](https://os2.eu) or by [contacting OS2 directly](https://os2.eu/kontakt) to make sure you are heading in the right direction. | ||
|
||
### Code style | ||
To keep the code clean and readable, *Please include links to coding standards and tools used:* | ||
|
||
Whenever a branch is pushed or a pull request is made, the code will be checked in CI by the tools mentioned above, so make sure to install these tools and run them locally before pushing branches/making PRs. | ||
|
||
### Forking the repository | ||
In order to implement changes to *OS2produkt* when you do not have rights for the required repository, you must first fork the repository. Once the repository is forked, you can clone it to your local machine. | ||
|
||
### Making the changes | ||
On your local machine, create a new branch, and name it like: | ||
- `feature/some-new-feature`, if the changes implement a new feature | ||
- `issue/some-issue`, if the changes fix an issue | ||
|
||
Once you have made changes or additions to the code, you can commit them (try to keep the commit message descriptive but short). If an issue exists in the issue list for the changes you made, be sure to format your commit message like `"Fixes #<issue_id> -- description of changes made`, where `<issue_id>"` corresponds to the number of the issue on Jira or GitHub. To demonstrate that the changes implement the new feature/fix the issue, make sure to also add tests. | ||
|
||
### Making a pull request | ||
If all changes have been committed, you can push the branch to your fork of the repository and create a pull request to the `master` branch of the *OS2produkt* repository. Your pull request will be reviewed, if applicable feedback will be given and if everything is approved, it will be merged. | ||
|
||
### Reviews on releases | ||
|
||
All pull requests will be reviewed before they are merged to a release branch. As well as being reviewed for functionality and following the code style they will be checked with the steering committee and/or the coordination group for the project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Governance in the project | ||
|
||
The product/project is part of OS2's portfolio and is maintained according to the model defined by the association OS2. | ||
|
||
## Definitions | ||
|
||
### Project | ||
|
||
### Product | ||
|
||
### Users | ||
are those whose primary relationship to the product/project is to consume/use it's code and othere results. | ||
|
||
### Contributors | ||
are those who make contributions to the product/project, ranging from casual to significant, but who aren't responsible for it's overall success. | ||
|
||
### Maintainers | ||
are those who are responsible for the future of a project's repository (or respositories), whoses decisions affect the project laterally. Maintainers can be thought of as "trustees" or stewards of the project/product. |
Oops, something went wrong.