generated from tegonal/oss-template
-
Notifications
You must be signed in to change notification settings - Fork 2
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
Showing
16 changed files
with
66 additions
and
1,332 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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# Contributing to PROJECT_NAME | ||
# Contributing to scala-commons | ||
|
||
Thank you very much for taking your time to contribute to PROJECT_NAME :smiley: | ||
Thank you very much for taking your time to contribute to scala-commons :smiley: | ||
|
||
Following a few guidelines so that others can quickly benefit from your contribution. | ||
|
||
|
@@ -10,28 +10,28 @@ Following a few guidelines so that others can quickly benefit from your contribu | |
|
||
## Code of Conduct | ||
This project and everyone participating in it is governed by this project's | ||
[Code of Conduct](https://github.com/tegonal/PROJECT_NAME/tree/main/.github/CODE_OF_CONDUCT.md). | ||
[Code of Conduct](https://github.com/tegonal/scala-commons/tree/main/.github/CODE_OF_CONDUCT.md). | ||
By participating, you are expected to uphold this code. Please report unacceptable behaviour to [email protected] | ||
|
||
## How to Contribute | ||
- Star PROJECT_NAME if you like it. | ||
- Star scala-commons if you like it. | ||
|
||
- Need help using a feature? | ||
Open a [new discussion](https://github.com/tegonal/PROJECT_NAME/discussions/new?category=q-a) | ||
Open a [new discussion](https://github.com/tegonal/scala-commons/discussions/new?category=q-a) | ||
and write down your question there and we will get back to you. | ||
|
||
- Found a bug? | ||
[Open an issue](https://github.com/tegonal/PROJECT_NAME/issues/new?template=bug_report.md). | ||
[Open an issue](https://github.com/tegonal/scala-commons/issues/new?template=bug_report.md). | ||
|
||
- Missing a feature? | ||
Open a [new discussion](https://github.com/tegonal/PROJECT_NAME/discussions/new?category=ideas) | ||
Open a [new discussion](https://github.com/tegonal/scala-commons/discussions/new?category=ideas) | ||
and write down your need and we will get back to you. | ||
|
||
- Found spelling mistakes? | ||
Nice catch 🧐 Please fix it and create a pull request. | ||
|
||
In any case, if you are uncertain how you can contribute, then contact us via a | ||
[new discussion](https://github.com/tegonal/PROJECT_NAME/discussions/new?category=contributor-q-a) | ||
[new discussion](https://github.com/tegonal/scala-commons/discussions/new?category=contributor-q-a) | ||
and we will figure it out together :smile: | ||
|
||
## Your First Code Contribution | ||
|
@@ -43,8 +43,8 @@ The following are a few guidelines on how we suggest you start. | |
2. Read up the [Pull Request Checklist](#pull-request-checklist) | ||
|
||
Perfect, you are setup and ready to go. | ||
Have a look at [help wanted issues](https://github.com/tegonal/PROJECT_NAME/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) | ||
where [good first issues](https://github.com/tegonal/PROJECT_NAME/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) | ||
Have a look at [help wanted issues](https://github.com/tegonal/scala-commons/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) | ||
where [good first issues](https://github.com/tegonal/scala-commons/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) | ||
are easier to start with. | ||
Please write a comment such as `I'll work on this` in the issue, | ||
this way we can assign the task to you (so that others know there is already someone working on the issue) | ||
|
@@ -58,15 +58,15 @@ Dealing with Git for the first time? Here are some recommendations for how to se | |
should be descriptive of the issue or the change being made, e.g `#108-path-exists`.) Working | ||
on a new branch makes it easier to make more than one pull request. | ||
- add this repository as a remote repository using | ||
`git remote add upstream https://github.com/tegonal/PROJECT_NAME.git`. You will use this to | ||
`git remote add upstream https://github.com/tegonal/scala-commons.git`. You will use this to | ||
fetch changes made in this repository. | ||
- to ensure your branch is up-to-date, rebase your work on | ||
upstream/main using `git rebase upstream/main` or `git pull -r upstream main`. | ||
This will add all new changes in this repository into your branch and place your | ||
local unpushed changes at the top of the branch. | ||
|
||
You can read more on Git [here](https://git-scm.com/book/). | ||
Contact us via a [new discussion](https://github.com/tegonal/PROJECT_NAME/discussions/new?category=contributor-q-a) | ||
Contact us via a [new discussion](https://github.com/tegonal/scala-commons/discussions/new?category=contributor-q-a) | ||
whenever you need help to get up and running or have questions. | ||
|
||
*Create a Draft* | ||
|
@@ -82,12 +82,12 @@ Finally, when you think your PR (short for pull request) is ready, then please: | |
|
||
1. read the [Pull Request Checklist](#pull-request-checklist) | ||
2. Create your first pull-request | ||
3. 👏👏👏 you have submitted your first code contribution to tegonal/PROJECT_NAME 😊 | ||
3. 👏👏👏 you have submitted your first code contribution to tegonal/scala-commons 😊 | ||
|
||
|
||
## Pull Request Checklist | ||
Please make sure you can check every item on the following list before you create a pull request: | ||
- [ ] your pull request is rebased on the [latest commit on main](https://github.com/tegonal/PROJECT_NAME/commits/main) | ||
- [ ] your pull request is rebased on the [latest commit on main](https://github.com/tegonal/scala-commons/commits/main) | ||
- [ ] Your pull request addresses only “one thing”. It cannot be meaningfully split up into multiple pull requests. | ||
- [ ] There is no error if you run ./scripts/before-pr.sh | ||
- [ ] Make sure you have no changes after running ./scripts/before-pr.sh and `git commit --amend` otherwise | ||
|
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
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
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
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
|
||
|
||
______________________________________ | ||
I confirm that I have read the [Contributor Agreement v1.1](https://github.com/tegonal/PROJECT_NAME_GITHUB/blob/main/.github/Contributor%20Agreement.txt), agree to be bound on them and confirm that my contribution is compliant. | ||
I confirm that I have read the [Contributor Agreement v1.1](https://github.com/tegonal/scala-commons/blob/main/.github/Contributor%20Agreement.txt), agree to be bound on them and confirm that my contribution is compliant. |
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 |
---|---|---|
@@ -1,7 +1,7 @@ | ||
# | ||
# __ __ | ||
# / /____ ___ ____ ___ ___ _/ / This file is provided to you by https://github.com/tegonal/PROJECT_NAME | ||
# / __/ -_) _ `/ _ \/ _ \/ _ `/ / Copyright YEAR Tegonal Genossenschaft <[email protected]> | ||
# / /____ ___ ____ ___ ___ _/ / This file is provided to you by https://github.com/tegonal/scala-commons | ||
# / __/ -_) _ `/ _ \/ _ \/ _ `/ / Copyright 2024 Tegonal Genossenschaft <[email protected]> | ||
# \__/\__/\_, /\___/_//_/\_,_/_/ It is licensed under Creative Commons Zero v1.0 Universal | ||
# /___/ Please report bugs and contribute back your improvements | ||
# | ||
|
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
Oops, something went wrong.