Skip to content

Commit

Permalink
Added contributing, code of conduct, pull request templases, windows …
Browse files Browse the repository at this point in the history
…build script
  • Loading branch information
valasek committed Jan 5, 2019
1 parent 2dfd7db commit 4c0b712
Show file tree
Hide file tree
Showing 9 changed files with 145 additions and 16 deletions.
16 changes: 12 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
# file types
*.o
*.a
*.so
*.exe
*.test
*.prof
*.db
*.DS_Store

# Binaries for programs and plugins
timesheet.zip
*.exe
*.bin
*.app
*.app.zip
*.exe~
*.dll
*.so
*.o
*.a
*.dylib

# folders
vendor
Expand Down
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# 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 at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems 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 [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contributing to Timesheet

This is an open source project.

I appreciate your help!

## Filing issues

When filing an issue, make sure to answer these five questions:

1. What version of rajce-get are you using (`rajce-get version`)?
2. What operating system and processor architecture are you using?
3. What did you do?
4. What did you expect to see?
5. What did you see instead?
## Contributing code
Unless otherwise noted, the Timesheet source files are distributed under
the MIT license found in the LICENSE file.
6 changes: 6 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
**Before submitting a pull request,** please make sure the following is done:

1. Fork [the repository](https://github.com/valasek/timesheet) and create your branch from `master`.
2. If you've fixed a bug or added code that should be tested, add tests!
3. Format your code with fmt (`go fmt`).
4. Optional - ensure the test suite passes (`go test`).
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Timesheet for consultants
# Timesheet

[![GitHub release](https://img.shields.io/github/release-pre/valasek/timesheet.svg)](https://github.com/valasek/timesheet/releases)
[![GitHub issues](https://img.shields.io/github/issues/valasek/timesheet.svg)](https://github.com/valasek/timesheet/issues)
Expand All @@ -9,15 +9,15 @@ Web application to report consulting hours on projects using selected rates on a

# Requirements

- Linux, Windows or macOS
- DB connection to PostgreSQL
- Initial yearly data in csv format (dates should be entered in ISO format YYYY-MM-DD HH:MM:SS):
- consultants, projects, rates, holidays, initial reported records - optional).
- Linux, Windows or MacOS
- DB connection to PostgreSQL - configute in timesheet.yaml
- Initiallize the DB using command `timesheet db --clean`
- Import initial data in csv format using command `timesheet db --load all`
- (dates should be entered in ISO format YYYY-MM-DD HH:MM:SS)
- consultants, projects, rates, holidays, initial reported records - optional

# Download - alpha release
* [timesheet.zip](https://github.com/valasek/timesheet/releases/download/0.0.2/timesheet.zip) (MS Windows 64bit)
* build from source (Linux 64bit)
* build from source (Mac OS X 64bit)
# Download
* [Releases](https://github.com/valasek/timesheet/releases/) (MS Windows 64bit, Linux 64bit, Mac OS X 64bit)

# Usage

Expand Down
49 changes: 49 additions & 0 deletions build.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
@ECHO OFF
set zip="C:\Program Files\7-Zip\7z.exe"

ECHO ==============================================
ECHO Removing aftifacts from the previous build ...
IF EXIST .\build\timesheet.exe del .\build\timesheet.exe
IF EXIST .\build\timesheet.app del .\build\timesheet.app
IF EXIST .\build\timesheet.bin del .\build\timesheet.bin
IF EXIST .\build\timesheet.yaml del .\build\timesheet.yaml
IF EXIST .\build\MS_Windows_64b.zip del .\build\MS_Windows_64b.zip
IF EXIST .\build\Linux_64b.zip del .\build\Linux_64b.zip
IF EXIST .\build\Mac_OS_X_64b.zip del .\build\Mac_OS_X_64b.zip
IF EXIST ".\build\client\dist\" @RD /S /Q ".\build\client\dist"

ECHO ======================
ECHO Compiling frontend ...
cd .\client
call npm run build
xcopy .\dist .\..\build\client\dist\ /s /e
cd ..

ECHO =====================
ECHO Compiling backend ...
copy .\timesheet.yaml .\build\timesheet.yaml
ECHO MS Windows ...
set GOOS=windows
set GOARCH=amd64
go build -o .\build\timesheet.exe .\timesheet.go
ECHO Linux ...
set GOOS=linux
set GOARCH=amd64
go build -o .\build\timesheet.bin .\timesheet.go
ECHO MAC OS X ...
set GOOS=darwin
set GOARCH=amd64
go build -o .\build\timesheet.app .\timesheet.go

ECHO =========================
ECHO Compressing artifacts ...
cd .\build
call %zip% a -r MS_Windows_64b.zip timesheet.exe timesheet.yaml client/
call %zip% a -r Linux_64b.zip ./timesheet.bin ./timesheet.yaml client/
call %zip% a -r Mac_OS_X_64b.zip ./timesheet.app ./timesheet.yaml client/
cd ..

ECHO ===========
ECHO Builds ready

@ECHO ON
2 changes: 1 addition & 1 deletion client/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "timesheet",
"version": "0.0.1",
"version": "0.0.3",
"private": true,
"scripts": {
"serve": "vue-cli-service serve",
Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ var cfgFile string
// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
Use: "timesheet",
Version: "timesheet 0.0.2",
Version: "timesheet 0.0.3",
Short: "Web based timesheet application with DB persistence",
Long: `Web based timesheet application with DB persistence.
Expand Down
2 changes: 1 addition & 1 deletion timesheet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ data:
rates: "rates_demo.csv"
projects: "projects_demo.csv"
reportedRecords: "reportedRecords_demo.csv"
holidays: "holidays_us_2019.csv"
holidays: "holidays_us_2019.csv"

0 comments on commit 4c0b712

Please sign in to comment.