Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v0.1.0 #119

Merged
merged 24 commits into from
Jun 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
eaed80c
Create CONTRIBUTING.md
yakuter May 29, 2020
27f96b7
Update CONTRIBUTING.md
yakuter May 29, 2020
2b6f3d9
Update CONTRIBUTING.md
yakuter May 29, 2020
1205825
Update CONTRIBUTING.md
yakuter May 29, 2020
e531b27
Update CONTRIBUTING.md
yakuter May 29, 2020
4e8b446
Update CONTRIBUTING.md
yakuter May 29, 2020
bfb621c
Update CONTRIBUTING.md
yakuter May 29, 2020
93e5e9a
Update CONTRIBUTING.md
yakuter May 29, 2020
010ca62
Translation (#103)
recep May 29, 2020
a957653
Update CONTRIBUTING.md
yakuter May 29, 2020
bdac434
Update CONTRIBUTING.md
yakuter May 29, 2020
769f815
Update CONTRIBUTING-TR.md
yakuter May 29, 2020
28831ec
pre-generated issue template added (#106)
mrtrkmn May 29, 2020
b21514e
Removed unnecessary alpine image (#109)
TheYkk May 30, 2020
31127db
password package implemented (#112)
mrtrkmn May 31, 2020
a12df11
rename and delete deprecated todo
mrtrkmn Jun 3, 2020
c1404a7
Merge branch 'hotfix/imply-some-renaming-#114' of https://github.com/…
yakuter Jun 3, 2020
0c4c84f
Merge branch 'mrturkmen06-hotfix/imply-some-renaming-#114'
yakuter Jun 3, 2020
91f15f5
Merge branch 'master' of https://github.com/pass-wall/passwall-server
yakuter Jun 3, 2020
f3c3baa
Feature/add health check #113 (#115)
mrtrkmn Jun 3, 2020
168eac4
Closes #118
yakuter Jun 3, 2020
dc8b409
Merge branch 'master' of https://github.com/pass-wall/passwall-server
yakuter Jun 3, 2020
2d13948
update health test
yakuter Jun 3, 2020
b332105
workflow db user info
yakuter Jun 3, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
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.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
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.
52 changes: 52 additions & 0 deletions .github/workflows/buildtest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Build Server & Test
on: [push, pull_request]

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-16.04, ubuntu-18.04]
services:
postgres:
image: postgres:alpine
env:
POSTGRES_PASSWORD: postgres
POSTGRES_USER: postgres
POSTGRES_DB: passwall
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
- 5432:5432

steps:
- name: Set up Go 1.14
uses: actions/setup-go@v1
with:
go-version: 1.14
id: go


- name: Check out code into the Go module directory
uses: actions/checkout@v1

- name: Get dependencies
run: |
go get -v -t -d ./...
if [ -f Gopkg.toml ]; then
curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
dep ensure
fi

- name: Build and Run Pass-Wall Server
run: |
go build -o passwall ./cmd/passwall-server/main.go
chmod +x ./passwall
./passwall &

- name: Run Tests
run: go test -v --race ./...

6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# PASSWALL CHANGELOG

## Version: [1.1.-] (2020-05---)
## Version: [1.1.1] (2020-06---)
### Changed
- Now only supports PostgreSQL
### Add
- Secure notes feature
### Removed
- Removed SQLite and MySQL support

## Version: [1.1.0] (2020-05-03)
### Add
Expand Down
130 changes: 130 additions & 0 deletions CONTRIBUTING-TR.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
PassWall'e Katkı
=============================

PassWall'e yardım etmek mi istiyorsun? Mükemmel, aramıza hoşgeldin. Bu dokümanı projeye nasıl katkıda bulunabileceğini göstermek için hazırladık. Gelecek katkıların için şimdiden teşekkürler.

İletişim kanalları
------------

- "Nasıl yapılır?" soruları için [StackOverflow](https://stackoverflow.com/questions/tagged/passwall).
- Hata (Bug) bildirimi, özellik (feature) önerisi veya proje kaynak kodu için [GitHub](https://github.com/pass-wall/passwall-server/issues).
- Konu tartışmaları için [Slack](https://passwall.slack.com).
- E-posta ile iletişim için [[email protected]](mailto:[email protected]).

Katkıda bulunacak bir şeyi nasıl bulabilirim ?
------------
1. Öncelikle katkıda bulunulacak her konunun bir issue'su olması gerektiğini unutmayın. Bunun için [issue](https://github.com/pass-wall/passwall-server/issues) sayfasına bakabilirsiniz.

1. Issue sayfasında öncelikle [help wanted](https://github.com/pass-wall/passwall-server/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issue'larına bakın.

1. Sonrasında koddaki [// TODO:](https://github.com/pass-wall/passwall-server/search?q=TODO&unscoped_q=TODO) kısımlarını düzeltmeyi deneyebilirsiniz.

1. Eğer yeni bir özellik (feature) olarak iyi bir fikriniz varsa veya bir hata (bug) bulursanız bu konuda bir konu (issue) açmaktan çekinmeyin ve eğer konu üzerinde çalışmak istiyorsanız mutlaka belirtin.

Görevlendirmeler
------------

Katkıda bulunucak bir şey bulduğunuzda;
1. Eğer henüz açılmamışsa onunla ilgili bir issue açın,

1. Bu issue için kimsenin görevlendirilmediğinden emin olun,

1. Issue üzerinde çalışmak istediğinizi açmış olduğunuz issue'nun sonunda belirtin.

Bu işlemler sonrasında ilgili issue için görevlendirilirsisniz (assign).

Commit'ler ve Pull Request'ler
------------

Nitelikli pull request'ler - yamalar, iyileştirmeler, yeni özellikler - bizim için harika yardımlardır. Bu yamalar, iyileştirmeler, yeni özellikler için pull request'ler yapılırken konuya (issue) odaklanılmalı ve konu ile ilgilisi olmayan commit atmaktan kaçınılmalıdır.

Lütfen büyük kapsamlı ve ciddi pull request yapmadan önce bilgilendirme yapın (yeni özellikleri uygulama, kod düzenleme gibi). Aksi takdirde proje geliştiricilerinin değişiklik yapılmasını istemeyebileceği bir feature vb. üzerinde çalışmak için gereksiz zaman harcama riskiyle karşı karşıya kalabilirsiniz.

### Branch adlandırma politikası
PassWall aşağıdaki branch adlandırma politikasını kullanır.

<table>
<thead>
<tr>
<th>Instance</th>
<th>Branch</th>
<th>Description, Instructions, Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td>Stable</td>
<td>stable</td>
<td>Accepts merges from Working and Hotfixes</td>
</tr>
<tr>
<td>Working</td>
<td>master</td>
<td>Accepts merges from Features/Issues and Hotfixes</td>
</tr>
<tr>
<td>Features/Issues</td>
<td>topic-*</td>
<td>Always branch off HEAD of Working</td>
</tr>
<tr>
<td>Hotfix</td>
<td>hotfix-*</td>
<td>Always branch off Stable</td>
</tr>
</tbody>
</table>

Branch ve workflow hakkında daha fazla bilgi [burada](https://gist.github.com/digitaljhelms/4287848)

### Yeni Contributor'lar için

Eğer daha önce hiç pull request yapmadıysanız aramıza hoşgeldiniz :tada: :smile:.

1. Projeyi öncelikle fork'layın yani kendi alanınıza alın. ([Fork](http://help.github.com/fork-a-repo/)) ve remote'ları yapılandırın:

```bash
# Repo forkunuzu geçerli dizin üzerine klonlayın
git clone https://github.com/<your-username>/<repo-name>
# Klonlanan dizine gidin
cd <repo-name>
# Orjinal repoyu "upstream" adlı bir remote called'a atayın
git remote add upstream https://github.com/hoodiehq/<repo-name>
```

2. Eğer daha önce fork yaptıysanız, upstream üzerinden en son değişiklikleri alın:

```bash
git checkout master
git pull upstream master
```

3. Feature, fix ve değişiklikleriniz için yeni bir branch oluşturun (ana projenin development branch'ı olan master dışında):

```bash
git checkout -b <topic-branch-name>
```

4. Uygun olduğunda testleri güncellediğinizden veya yeni bir test eklediğinizden emin olun. Patch'ler ve feature'lar test olmadan kabul edilmeyecektir.

5. Eklediğiniz veya değişiklik yaptığınız düzenlemelerin belgelendirmesini `README.md` dosyası üzerinde yapmayı unutmayın.

6. Kendi oluşturduğunuz branch'ınız üzerinden fork'unuza push edin:

```bash
git push origin <topic-branch-name>
```

7. Net, anlaşılır bir başlık ve açıklama ile pull request açın. [Konu hakkında yardımcı döküman](https://help.github.com/articles/using-pull-requests/)

Açık kaynak projeye nasıl katkıda bulunulabileceğini anlatan daha detaylı bir dokümana [şuradan](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) ulaşabilirsiniz.

Hata bildirimi (Bug report)
------------

Bir hata bildirimi için issue açarken aşağıdaki beş soruya cevap verdiğinizden emin olun.
1. Kullanılan GO sürümü nedir?
2. Hangi işletim sistemi ve işlemci mimarisi kullanıyorsunuz?
3. Ne yaptın?
4. Ne görmeyi bekliyordun?
5. Onun yerine ne gördün?
134 changes: 134 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
Contributing to PassWall
=============================

You are here to help on PassWall? Awesome, feel welcome and read the
following sections in order to know how to ask questions and how to work on something.

Get in touch
------------

- Ask usage questions ("How do I?") on [StackOverflow](https://stackoverflow.com/questions/tagged/passwall).
- Report bugs or suggest features on [GitHub issues](https://github.com/pass-wall/passwall-server/issues).
- Discuss topics on [Slack](https://passwall.slack.com).
- Email us at [[email protected]](mailto:[email protected]).

How to find something to contribute?
------------

1. First look for [help wanted](https://github.com/pass-wall/passwall-server/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) issues.

1. Then you can try to fix [// TODO:](https://github.com/pass-wall/passwall-server/search?q=TODO&unscoped_q=TODO)'s in the code.

1. If you have a good idea as a `feature` or find a `bug`, feel free to open an issue about it and tell us that you want to work on this subject.

Assignment
------------

When you find something to contribute;
1. Open an issue about it,

1. Make sure that nobody assigned for that issue,

1. Tell us that you want to work on the issue and get you assigned.

Commits and Pull Requests
------------

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

PassWall uses the branch naming policy below.

### Branch naming policy

<table>
<thead>
<tr>
<th>Instance</th>
<th>Branch</th>
<th>Description, Instructions, Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td>Stable</td>
<td>stable</td>
<td>Accepts merges from Working and Hotfixes</td>
</tr>
<tr>
<td>Working</td>
<td>master</td>
<td>Accepts merges from Features/Issues and Hotfixes</td>
</tr>
<tr>
<td>Features/Issues</td>
<td>topic-*</td>
<td>Always branch off HEAD of Working</td>
</tr>
<tr>
<td>Hotfix</td>
<td>hotfix-*</td>
<td>Always branch off Stable</td>
</tr>
</tbody>
</table>

More about branchs and workflow [here](https://gist.github.com/digitaljhelms/4287848)

### For new Contributors

If you never created a pull request before, welcome :tada: :smile: [Here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
on how to send one :)

1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
and configure the remotes:

```bash
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/<repo-name>
# Navigate to the newly cloned directory
cd <repo-name>
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/pass-wall/<repo-name>
```

2. If you cloned a while ago, get the latest changes from upstream:

```bash
git checkout master
git pull upstream master
```

3. Create a new topic branch (off the main project development branch) to
contain your feature, change, or fix:

```bash
git checkout -b <topic-branch-name>
```

4. Make sure to update or add to the tests when appropriate. Patches and
features will not be accepted without tests.

5. If you added or changed a feature, make sure to document it accordingly in
the `README.md` file.

6. Push your topic branch up to your fork:

```bash
git push origin <topic-branch-name>
```

8. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description.


How to report a bug
------------

When filing an issue, make sure to answer these five questions:
1. What version of Go are you using (go 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?
Loading