3
3
By submitting a pull request, you represent that you have the right to license your contribution to the community, and agree by submitting the patch
4
4
that your contributions are licensed under the [ Apache 2.0 license] ( https://www.apache.org/licenses/LICENSE-2.0.html ) (see [ ` LICENSE ` ] ( ../LICENSE ) ).
5
5
6
- ## Submitting a Bug
6
+ ## Contributor Conduct
7
7
8
- Please ensure to specify the following:
9
-
10
- * ** RediStack** commit hash
11
- * Simplest possible steps to reproduce
12
- * A pull request with a failing test case is preferred, but it's just as fine to write it in the issue description
13
- * Environment Information
14
- * For example, are you running in Docker? How are you connecting to it through Docker? What version of Docker?
15
- * OS version and output of ` uname -a `
16
- * Swift version or output of ` swift --version `
8
+ All contributors are expected to adhere to this project's [ Code of Conduct] ( CODE_OF_CONDUCT.md ) .
17
9
18
10
## Development
19
11
12
+ ### File Copyright Headers
13
+
14
+ When adding a new file to the project, add the following heading to the top of the file:
15
+
16
+ ```
17
+ //===----------------------------------------------------------------------===//
18
+ //
19
+ // This source file is part of the RediStack open source project
20
+ //
21
+ // Copyright (c) 2019-2020 RediStack project authors
22
+ // Licensed under Apache License v2.0
23
+ //
24
+ // See LICENSE.txt for license information
25
+ // See CONTRIBUTORS.txt for the list of RediStack project authors
26
+ //
27
+ // SPDX-License-Identifier: Apache-2.0
28
+ //
29
+ //===----------------------------------------------------------------------===//
30
+ ```
31
+
32
+ When editing a file, ensure that the copyright header states the year ` 2019-<current year> ` .
33
+
20
34
### Git Workflow
21
35
22
36
` master ` is always the development branch.
@@ -33,15 +47,13 @@ docker run -d -p 6379:6379 --name redis redis:5
33
47
34
48
Otherwise, install Redis directly on your machine from [ Redis.io] ( https://redis.io/download ) .
35
49
36
- ### Submitting a Pull Request
50
+ ### Submitting a Merge Request
51
+
52
+ > The easiest way to create a great merge requests is to use one of the [ Merge Request Templates] ( ./.gitlab/merge_request_templates ) .
37
53
38
- A great PR that is likely to be merged quickly is:
54
+ A great MR that is likely to be merged quickly is:
39
55
40
56
1 . Concise, with as few changes as needed to achieve the end result.
41
57
1 . Tested, ensuring that regressions aren't introduced now or in the future.
42
58
1 . Documented, adding API documentation as needed to cover new functions and properties.
43
59
1 . Accompanied by a [ great commit message] ( https://chris.beams.io/posts/git-commit/ )
44
-
45
- # Contributor Conduct
46
-
47
- All contributors are expected to adhere to this project's [ Code of Conduct] ( CODE_OF_CONDUCT.md ) .
0 commit comments