Skip to content

Commit 49755ea

Browse files
authored
fix: mention CLA (#63)
1 parent 9163fbf commit 49755ea

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
We welcome your contributions to the Midnight network! By contributing, you'll play a vital role in shaping the future of a blockchain focused on data privacy.
44

5+
## Contributor License Agreement
6+
7+
Like many other open source projects, we ask contributors to sign a contributor
8+
License Agreement before accepting contributions. We use CLA assistant (https://github.com/cla-assistant/cla-assistant) to streamline the CLA
9+
signing process, enabling contributors to sign our CLAs directly within a GitHub pull request.
10+
511
## Getting Started
612

713
* **Review Existing Contributions and Issues:** Before submitting, please check if a similar issue or feature request already exists by searching our issue tracker.
@@ -24,19 +30,43 @@ Ensure the title is a clear summary of the requirement and provides enough conte
2430

2531
* **Pull Requests:** Code contributions are submitted via Pull Requests.
2632
* **Fork the Repository:** Create your own fork of the Midnight repository.
27-
* **Create a Branch:** Make your changes in a separate branch.
33+
* **Create a Branch:** Make your changes in a separate branch,
34+
prefixed with a short name moniker (e.g. `jill-my-feature`).
2835
* **Follow Coding Standards:** Adhere to the coding style guides specified in our documentation.
2936
* **Write Tests:** Include unit tests and integration tests to cover your changes.
3037
* **Commit Messages:** Write clear and concise commit messages.
3138
* **Submit Pull Request:** Submit your pull request to the appropriate branch in the main repository.
32-
* **Code Review:** All pull requests undergo code review by project maintainers. Be prepared to address feedback from reviewers.
39+
* **Please do not `--force` pushes** - doing so means that reviewers will have to re-review all
40+
commits in the PR rather than commits since last review.
41+
* **Code Review:** All pull requests undergo code review by project maintainers.
42+
Be prepared to address feedback from reviewers.
3343

3444
## Requirements for Acceptable Contributions:
3545

3646
* **Coding Standards:** Code must adhere to the coding style guides defined in our documentation
3747
* **Testing:** New functionality must include corresponding unit tests and integration tests.
3848
* **Documentation:** Code changes should be accompanied by proposed relevant documentation updates.
3949
* **License:** All contributions must be compatible with the project's license.
50+
Where possible all files should have this license header:
51+
52+
```ts
53+
// This file is part of midnight-node-docker.
54+
// Copyright (C) 2025 Midnight Foundation
55+
// SPDX-License-Identifier: Apache-2.0
56+
// Licensed under the Apache License, Version 2.0 (the "License");
57+
// You may not use this file except in compliance with the License.
58+
// You may obtain a copy of the License at
59+
//
60+
// http://www.apache.org/licenses/LICENSE-2.0
61+
//
62+
// Unless required by applicable law or agreed to in writing, software
63+
// distributed under the License is distributed on an "AS IS" BASIS,
64+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
65+
// See the License for the specific language governing permissions and
66+
// limitations under the License.
67+
```
68+
69+
Where this is not possible, a copy of the Apache 2.0 or the repository's top-level LICENSE file in the same directory is required
4070

4171
## Support and Communication:
4272

0 commit comments

Comments
 (0)