Skip to content
Open
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
13 changes: 8 additions & 5 deletions .github/workflows/lineendings.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
name: 'Check CAP Line Endings'
name: "Check CAP Line Endings"

on:
push:
branches:
- master
- master
pull_request:

jobs:
lineendings:
runs-on: ubuntu-latest
steps:
- run: sudo apt-get update && sudo apt-get install dos2unix
- uses: actions/checkout@v5
- run: (ls core/cap-*.md | xargs -I '{}' sh -c 'cat {} | dos2unix | cmp - {}') || (echo 'Documents listed above contain CRLF line endings, and should be LF.'; exit 1)
- run: sudo apt-get update && sudo apt-get install dos2unix
- uses: actions/checkout@v5
- run:
(ls core/cap-*.md | xargs -I '{}' sh -c 'cat {} | dos2unix | cmp -
{}') || (echo 'Documents listed above contain CRLF line endings, and
should be LF.'; exit 1)
24 changes: 11 additions & 13 deletions .github/workflows/mddiffcheck.yml
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
name: 'Check CAP Diffs'
name: "Check CAP Diffs"

on:
push:
branches:
- master
- master
pull_request:

jobs:
mddiffcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- name: Set up Go
uses: actions/setup-go@v6
with:
go-version: ^1.24
- run: go install github.com/stellar/mddiffcheck@v1
- run: >
mddiffcheck
-repo
'https://github.com/stellar/stellar-core https://github.com/stellar/stellar-xdr'
core/*.md
- uses: actions/checkout@v5
- name: Set up Go
uses: actions/setup-go@v6
with:
go-version: ^1.24
- run: go install github.com/stellar/mddiffcheck@v1
- run: >
mddiffcheck -repo 'https://github.com/stellar/stellar-core
https://github.com/stellar/stellar-xdr' core/*.md
3 changes: 1 addition & 2 deletions .github/workflows/prettier.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 'Prettier for SEP files'
name: "Prettier for SEP files"

on:
pull_request:
Expand All @@ -13,6 +13,5 @@ jobs:
with:
node-version: 24
- run: corepack enable
- run: corepack prepare yarn@stable --activate
- run: yarn install --frozen-lockfile
- run: yarn sep-check
18 changes: 12 additions & 6 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: 'Stale Issues'
name: "Stale Issues"

on:
schedule:
- cron: '0 18 * * *' # approx 9:30am daily
- cron: "0 18 * * *" # approx 9:30am daily

jobs:
stale:
Expand All @@ -14,10 +14,16 @@ jobs:
debug-only: false
days-before-stale: 30
days-before-close: 30
stale-issue-message: 'This issue is stale because it has been open for 30 days with no activity. It will be closed in 30 days unless the stale label is removed.'
stale-pr-message: 'This pull request is stale because it has been open for 30 days with no activity. It will be closed in 30 days unless the stale label is removed.'
stale-issue-message:
"This issue is stale because it has been open for 30 days with no
activity. It will be closed in 30 days unless the stale label is
removed."
stale-pr-message:
"This pull request is stale because it has been open for 30 days
with no activity. It will be closed in 30 days unless the stale
label is removed."
stale-issue-label: stale
stale-pr-label: stale
exempt-issue-labels: 'needs draft,needs pilot,accepted,blocked'
exempt-pr-labels: 'needs draft,needs pilot,accepted,blocked'
exempt-issue-labels: "needs draft,needs pilot,accepted,blocked"
exempt-pr-labels: "needs draft,needs pilot,accepted,blocked"
remove-stale-when-updated: true
22 changes: 13 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,26 @@

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Check out the [Stellar Contribution Guide](https://github.com/stellar/.github/blob/master/CONTRIBUTING.md) for details
on contributing to stellar-core and Stellar's other repositories, especially with regard to our code of conduct and
contributor license agreement.
Check out the
[Stellar Contribution Guide](https://github.com/stellar/.github/blob/master/CONTRIBUTING.md)
for details on contributing to stellar-core and Stellar's other repositories,
especially with regard to our code of conduct and contributor license
agreement.

# CAP Contribution Process

CAPs deal with changes to the core protocol of the Stellar network.

Please see the contribution process outlined in [the core folder](core/README.md).
Please see the contribution process outlined in
[the core folder](core/README.md).

# SEP Contribution Process

SEPs deal with changes to the standards, protocols, and methods used in the ecosystem built on top of the Stellar
network.
SEPs deal with changes to the standards, protocols, and methods used in the
ecosystem built on top of the Stellar network.

Please see the contribution process outlined in [the ecosystem folder](ecosystem/README.md).
Please see the contribution process outlined in
[the ecosystem folder](ecosystem/README.md).

Please run `./bin/prettier.sh` or `yarn sep-prettify` (if your OS doesn't have sh) before submitting
your PR.
Please run `./bin/prettier.sh` or `yarn sep-prettify` (if your OS doesn't have
sh) before submitting your PR.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,34 @@
<a href="./ecosystem/README.md"><img alt="Docs: SEPs" src="https://img.shields.io/badge/docs-SEPs-blue" /></a>
</p>

This repository is home to **Core Advancement Proposals** (CAPs) and **Stellar Ecosystem Proposals**
(SEPs).
This repository is home to **Core Advancement Proposals** (CAPs) and **Stellar
Ecosystem Proposals** (SEPs).

Similar to [BIPs](https://github.com/bitcoin/bips) and [EIPs](https://github.com/ethereum/EIPs),
CAPs and SEPs are the proposals of standards to improve the Stellar protocol and related client APIs.
Similar to [BIPs](https://github.com/bitcoin/bips) and
[EIPs](https://github.com/ethereum/EIPs), CAPs and SEPs are the proposals of
standards to improve the Stellar protocol and related client APIs.

CAPs deal with changes to the core protocol of the Stellar network. Please see [the process for CAPs](core/README.md).
CAPs deal with changes to the core protocol of the Stellar network. Please see
[the process for CAPs](core/README.md).

SEPs deal with changes to the standards, protocols, and methods used in the ecosystem built on top
of the Stellar network. Please see [the process for SEPs](ecosystem/README.md).
SEPs deal with changes to the standards, protocols, and methods used in the
ecosystem built on top of the Stellar network. Please see
[the process for SEPs](ecosystem/README.md).

## Repository structure

The root directory of this repository contains:

* Templates for creating your own CAP or SEP
* `contents` directory with `[cap | sep]-xxxx` subdirectories that contain all media/script files for a given CAP or SEP document.
* core directory which contains accepted CAPs (`cap-xxxx.md` where `xxxx` is a CAP number with leading zeros, ex. `cap-0051.md`)
* ecosystem directory which contains accepted SEPs (`sep-xxxx.md` where `xxxx` is a SEP number with leading zeros, ex. `sep-0051.md`)
- Templates for creating your own CAP or SEP
- `contents` directory with `[cap | sep]-xxxx` subdirectories that contain all
media/script files for a given CAP or SEP document.
- core directory which contains accepted CAPs (`cap-xxxx.md` where `xxxx` is a
CAP number with leading zeros, ex. `cap-0051.md`)
- ecosystem directory which contains accepted SEPs (`sep-xxxx.md` where `xxxx`
is a SEP number with leading zeros, ex. `sep-0051.md`)

Example repository structure:

```
├── CONTRIBUTING.md
├── README.md
Expand Down
Loading
Loading