Skip to content

Commit

Permalink
Update and rename README.md to README.adoc
Browse files Browse the repository at this point in the history
added contributing guideline and changed the file to adoc
  • Loading branch information
ronja-ui authored Jan 9, 2024
1 parent 7f4635f commit 603307e
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md → README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Teragrep Logo](https://avatars.githubusercontent.com/u/71876378?s=200&v=4)
image::https://avatars.githubusercontent.com/u/71876378?s=200&v=4[Teragrep Logo]

# Syslog Javascript Client

Expand Down Expand Up @@ -76,3 +76,24 @@ else {
}
```

## Contributing

// Change the repository name in the issues link to match with your project's name

You can involve yourself with our project by https://github.com/teragrep/repo-template/issues/new/choose[opening an issue] or submitting a pull request.

Contribution requirements:

. *All changes must be accompanied by a new or changed test.* If you think testing is not required in your pull request, include a sufficient explanation as why you think so.
. Security checks must pass
. Pull requests must align with the principles and http://www.extremeprogramming.org/values.html[values] of extreme programming.
. Pull requests must follow the principles of Object Thinking and Elegant Objects (EO).

Read more in our https://github.com/teragrep/teragrep/blob/main/contributing.adoc[Contributing Guideline].

### Contributor License Agreement

Contributors must sign https://github.com/teragrep/teragrep/blob/main/cla.adoc[Teragrep Contributor License Agreement] before a pull request is accepted to organization's repositories.

You need to submit the CLA only once. After submitting the CLA you can contribute to all Teragrep's repositories.

0 comments on commit 603307e

Please sign in to comment.