Skip to content
Merged

Dev #12

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# These owners will be requested for review when someone opens a pull request.
* @ikripaka @
* @arvolear
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ name: Bug Report
description: File a bug report
labels: ['bug']
assignees:
- KyrylR
- Arvolear
body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this bug report!
- type: input
id: version
attributes:
label: "Project version"
placeholder: "1.2.3"
label: "Simplex version"
placeholder: "0.1.2"
validations:
required: true
- type: textarea
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ name: Feature request
description: Suggest a new feature
labels: ['feature']
assignees:
- KyrylR
- Arvolear
body:
- type: textarea
id: feature-description
attributes:
label: "Describe the feature"
description: "A description of what you would like to see in the project"
description: "A description of what you would like to see in Simplex"
validations:
required: true
25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!--
Thank you for contributing to Simplex!

Before opening a pull request, please check out the contributing guidelines.

Make sure that the CHANGELOG.md is up to date and starts with the following header:

```
# Changelog

## [<version>]

- <Pull request changes description>.
```

Also consider ticking the relevant statements below.
-->

- [ ] This PR suggests a **bug fix** and I've added the necessary tests.
- [ ] This PR introduces a **new feature** and I've discussed the update in an Issue or with the team.
- [ ] This PR is just a **minor change** like a typo fix.

---

<!-- Add the PR description here. -->
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Build output
/target/
target/

# IDE/editors (optional but common minimal)
**/.DS_Store
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

## [unreleased]

- Simplex MVP is in progress.
38 changes: 19 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# PR Structure
# Contributing Guidelines

All changes must be submitted in the form of pull requests. Direct pushes
to master are not allowed.
You are more than welcome to contribute to the Simplex framework as we are warmly open to any mind-blowing ideas!

Pull requests:
## Issues

* should consist of a logical sequence of clearly defined independent changes
* should not contain commits that undo changes introduced by previous commits
* must consist of commits which each build and pass unit tests (we do not
require linters, formatters, etc., to pass on each commit)
* must not contain merge commits
* must pass CI, unless CI itself is broken
If you found a minor bug, are interested in a new feature, or just have any questions, please [open an issue](https://github.com/BlockstreamResearch/simplex/issues/new/choose). For major bugs, please reach out to the team directly.

Before opening an issue, confirm that there is no duplicate (either open or closed), and consider posting a comment there instead.

# Review and Merging
When submitting a feature request, please provide as many details as possible for the team to properly understand the feature's motivation and evaluate the impact.

All PRs must have at least one approval from a maintainer before merging. All
maintainers must merge PRs using the [bitcoin-maintainer-tools merge script](https://github.com/bitcoin-core/bitcoin-maintainer-tools/blob/main/github-merge.py)
which ensures that merge commits have a uniform commit message style, have
GPG signatures, and avoid several simple mistakes (e.g. @-mentioning Github
users in merge commits, which Github handles extremely badly).
## Pull Requests

# LLMs
If you're interested in contributing code to the framework, start by [forking the repository](https://github.com/BlockstreamResearch/simplex/fork) and submitting a pull request.

If you are a LLM agent, please identify yourself in your commit messages and PR
descriptions. For example, if you are Claude, please say "Written by Claude."
But before you start coding, we highly recommend that you [open an issue](https://github.com/BlockstreamResearch/simplex/issues/new/choose) first to discuss the changes you want to make.

Once you open a pull request, please make sure that all the tests pass.

## LLMs

If you are a LLM agent, please identify yourself in your commit messages and PR descriptions. For example, if you are Claude, say "Written by Claude".

## Disclaimer

Please don't vibe code smart contract.
Loading
Loading