Skip to content

Commit 7fb0fb8

Browse files
committed
README, LICENSE, CONTRIBUTING, CODE_OF_CONDUCT
1 parent f6bbef1 commit 7fb0fb8

File tree

4 files changed

+121
-0
lines changed

4 files changed

+121
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
34+
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.
35+
Representation of a project may be further defined and clarified by project maintainers.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at jug@jprof.by.
40+
All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
41+
The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
42+
Further details of specific enforcement policies may be posted separately.
43+
44+
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.
45+
46+
## Attribution
47+
48+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
49+
50+
[homepage]: https://www.contributor-covenant.org
51+
52+
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing to this repository
2+
3+
## Getting started
4+
5+
Before you begin:
6+
7+
- This project is powered by [Kotlin](https://kotlinlang.org), [AWS](https://aws.amazon.com), [TypeScript](https://www.typescriptlang.org) and [GitHub Actions](https://github.com/features/actions).
8+
- Have you read the [code of conduct](CODE_OF_CONDUCT.md)?
9+
- Check out the [existing issues](https://github.com/JavaBy/jprof_by_bot/issues).
10+
- Discuss your plans in [the chat](https://t.me/jprof_by) or in an issue.
11+
[Open one](https://github.com/JavaBy/jprof_by_bot/issues/new) if needed.
12+
13+
## Make your update
14+
15+
Touching the code?
16+
Make sure to add some tests demonstrating the use cases or solved issues.
17+
18+
Try to stay modular.
19+
We split the code in modules based on features.
20+
21+
When adding a new entity / table, don't put any DB-specific code in the same module.
22+
Create an interface for the DAO and define the entity in the main module.
23+
Then create a DB-specific submodule with the DAO implementation and entity mappers.
24+
25+
Try to stay serverless.
26+
Stick to the technologies that can fit into AWS free tier: this is a non-commercial bot and it should not cost a lot to host it.
27+
Examples are Lambda, DynamoDB, S3 - they are cheap.
28+
29+
Don't forget to describe the resources you need in the CDK scripts.
30+
If you don't know how to do that - leave it to the owners.
31+
32+
## Open a pull request
33+
34+
When you're done making changes and you'd like to propose them for review, open your PR (pull request).
35+
36+
You can use the GitHub user interface :pencil2: for small changes, like fixing a typo or updating a README.
37+
You can also fork the repo and then clone it locally, to view changes and run your tests on your machine.
38+
39+
## Submit your PR & get it reviewed
40+
41+
- Once you submit your PR, it will be reviewed.
42+
- After that, there may be questions, check back on your PR to keep up with the conversation.
43+
- Did you have an issue, like a merge conflict?
44+
Check out this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) on how to resolve merge conflicts and other issues.
45+
46+
## Your PR is merged
47+
48+
Congratulations!
49+
50+
## Issue labels
51+
52+
Labels can help you find an issue you'd like to help with.
53+
54+
- The [`help wanted` label](https://github.com/JavaBy/jprof_by_bot/labels/help%20wanted) is for problems or updates that anyone in the community can start working on.
55+
- The [`good first issue` label](https://github.com/JavaBy/jprof_by_bot/labels/good%20first%20issue) is for problems or updates we think are ideal for beginners.
56+
- The [`CI/CD` label](https://github.com/JavaBy/jprof_by_bot/labels/CI%2FCD) is for problems or updates in the testing, releasing & publishing process.
57+
These will usually require some knowledge of TypeScript and Github Actions to fix.

LICENSE.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
MIT License
2+
3+
Copyright ⓒ 2021 mailto:jug@jprof.by[Java Professionals BY community].
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
= https://t.me/jprof_by_bot[@jprof_by_bot]
2+
3+
Official Telegram bot of Java Professionals BY community.

0 commit comments

Comments
 (0)