Skip to content

Commit 9bb4017

Browse files
tisniktisnik
authored
Merge pull request #1282 from tisnik/contributing-guidelines
Contributing guidelines
2 parents a7da069 + b1311f9 commit 9bb4017

2 files changed

Lines changed: 155 additions & 0 deletions

File tree

‎docs/demos/lcore/contributing_guidelines.html‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!doctype html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
6+
<title>Contributing guidelines</title>
7+
<link rel="stylesheet" href="dist/reset.css">
8+
<link rel="stylesheet" href="dist/reveal.css">
9+
<link rel="stylesheet" href="dist/theme/simple.css">
10+
<!--link rel="stylesheet" href="plugin/highlight/monokai.css"-->
11+
<link rel="stylesheet" href="plugin/highlight/github.css">
12+
</head>
13+
<body>
14+
<div class="reveal">
15+
<div class="slides">
16+
<section data-markdown="contributing_guidelines.md">
17+
</section>
18+
</div>
19+
</div>
20+
<script type="application/javascript" src="dist/reveal.js"></script>
21+
<script type="application/javascript" src="plugin/notes/notes.js"></script>
22+
<script type="application/javascript" src="plugin/markdown/markdown.js"></script>
23+
<script type="application/javascript" src="plugin/highlight/highlight.js"></script>
24+
<script type="application/javascript">
25+
Reveal.initialize({
26+
controls: true,
27+
progress: true,
28+
history: true,
29+
center: true,
30+
plugins: [ RevealMarkdown, RevealHighlight ]
31+
});
32+
</script>
33+
</body>
34+
</html>
35+

‎docs/demos/lcore/contributing_guidelines.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Lightspeed Core
2+
3+
![LCORE](images/lcore.jpg)
4+
5+
---
6+
7+
## Contributing guidelines
8+
9+
Pavel Tišnovský,
10+
ptisnovs@redhat.com
11+
12+
---
13+
14+
## Goals
15+
16+
* To be able to verify, review, test, and merge changes as effectively as possible
17+
* To make sure all feature requests and/or bug fixes are put into LCORE on time
18+
* To keep the project maintainable
19+
20+
---
21+
22+
## How?
23+
24+
* By making clear what are requirements for contributors and LCORE team
25+
26+
---
27+
28+
## New features
29+
30+
* It is a good idea to create Feature request in JIRA first
31+
* Then epics + issues can be created for this feature
32+
33+
---
34+
35+
## Setting up your development environment (1/2)
36+
37+
* Please don't create branches in upstream repository
38+
* (and don't push directly into the `main` branch ;)
39+
40+
---
41+
42+
## Setting up your development environment (2/2)
43+
44+
* Fork LCORE
45+
* Clone your fork
46+
* Setup devel environment with `uv`
47+
* Make a new branch
48+
* Push into the branch
49+
* Now pull request can be created from branch in your fork
50+
51+
---
52+
53+
## Pull requests
54+
55+
* Structure
56+
* Descriptions
57+
* Copyright
58+
* AI-generated content
59+
60+
---
61+
62+
## PR structure
63+
64+
* Please keep PR as small as possible!
65+
- the time to review seems to have O(x^n) complexity
66+
* All irrelevant changes will make review harder
67+
- + there's a chance it will be rejected (we tried to be nice)
68+
* Try to think about the overall project structure
69+
- utility functions
70+
- short handlers
71+
- refactoring
72+
73+
---
74+
75+
## PR description
76+
77+
* Jira ticket needs to be added into PR title
78+
- for example: `LCORE-740: type hints for models unit tests`
79+
* Fill-in all relevant information in the PR template
80+
- unused parts of PR template (like information about testing etc.) can be deleted
81+
* Use tags if you need/want to!
82+
* Mark PR as "Draft" if it is not ready for review
83+
* Please note that CodeRabbitAI will create a summary of your pull request
84+
85+
---
86+
87+
## AI assistants
88+
89+
* “Mark” code with substantial AI-generated portions.
90+
- nontrivial and substantial AI-generated or AI-assisted content
91+
* In a pull request/merge request description field, identify the code assistant that you used
92+
93+
---
94+
95+
## Copyright and licence notices
96+
97+
* If the contents of an entire file or files in PR were substantially generated
98+
by a code assistant with little to no creative input or modification by you
99+
(which should typically not be the case), copyright protection may be limited,
100+
but it is particularly appropriate to mark the contents of the file as
101+
recommended above.
102+
103+
---
104+
105+
## Maintainer role
106+
107+
* Please ask (ping) if you need to be added as a maintainer
108+
109+
---
110+
111+
## Approving pull request
112+
113+
* As SME you can, of course, approve pull request!
114+
* Please note that `/lgtm` does not work as expected
115+
* Use GH style - go to "Code changes" page and press "Submit review" button
116+
117+
---
118+
119+
## Thank you
120+

0 commit comments

Comments
 (0)