Skip to content

Commit f104a0c

Browse files
committed
docs: Add CONTRIBUTING.md and update README with more information
1 parent f16f1ea commit f104a0c

File tree

2 files changed

+55
-1
lines changed

2 files changed

+55
-1
lines changed

CONTRIBUTING.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to Scala Server Toolkit. All contributions are welcome if they are consistent with the goals
4+
and guidelines of the project.
5+
6+
It is better to open an issue in the project and discuss your intention with project maintainers before you actually start implementing
7+
something. They can also give you tips on how to go about implementing it.
8+
9+
## How to Contribute
10+
11+
Please read the [First Contributions Guide](https://github.com/firstcontributions/first-contributions/blob/master/README.md) for general
12+
information about contribution to OSS projects.
13+
14+
## Build
15+
16+
The project can be built and tested using simple SBT command:
17+
18+
```bash
19+
sbt test
20+
```
21+
22+
There is also an extra command called `check` which you should use to check your code before you submit a PR:
23+
24+
```bash
25+
sbt check
26+
```
27+
28+
Some of the reported problems can be automatically fixed by `fix`:
29+
30+
```bash
31+
sbt fix
32+
```
33+
34+
## Conventional Commits
35+
36+
The project uses [Conventional Commits](https://www.conventionalcommits.org) specification to have clear Git history and help with
37+
semantic versioning. Please read the specification and follow it (or look at already existing history for inspiration) if you commit into
38+
the project.

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,23 @@ the development of your server applications.
2626

2727
## Issues
2828

29-
Please report issues to [GitHub](https://github.com/avast/scala-server-toolkit/issues).
29+
Please report issues to [GitHub](https://github.com/avast/scala-server-toolkit/issues). Pull requests are always welcome.
30+
31+
## Versioning
32+
33+
The project follows the [semantic versioning](https://semver.org) schema which means that just by looking at the version you will know
34+
whether to expect compatibility problems or not.
35+
36+
The project values backwards compatibility but it cannot prevent innovation. There will be breaking changes but they will always be properly
37+
versioned and documented.
38+
39+
## Contributing
40+
41+
See [CONTRIBUTING.md](CONTRIBUTING.md).
42+
43+
## Code of Conduct
44+
45+
See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
3046

3147
## License
3248

0 commit comments

Comments
 (0)