Skip to content

Commit 9930c9c

Browse files
committed
feat: contributions.
1 parent 6cad8e8 commit 9930c9c

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Contribution Guidelines
2+
3+
| Task | Description |
4+
|------|-------------|
5+
| [Upcoming Events](https://github.com/movementlabsxyz/ffs/issues?q=is%3Aissue%20state%3Aopen%20label%3Apriority%3Ahigh%2Cpriority%3Amedium%20label%3Aevent) | High-priority `event` issues with planned completion dates. |
6+
| [Release Candidates](https://github.com/movementlabsxyz/ffs/issues?q=is%3Aissue%20state%3Aopen%20label%3Arelease-candidate) | Feature-complete versions linked to events. |
7+
| [Features & Bugs](https://github.com/movementlabsxyz/ffs/issues?q=is%3Aissue%20state%3Aopen%20label%3Afeature%2Cbug%20label%3Apriority%3Aurgent%2Cpriority%3Ahigh) | High-priority `feature` and `bug` issues. |
8+
9+
## How to contribute
10+
We welcome contributions to this project. We manage active development via issues. You may either submit and issue for triage or begin working on something already in the backlog. In both cases, we recommend you follow the initial steps below:
11+
12+
1. **Identify upcoming Events:** check for `priority:urgent` and `priority:high` issues tagged with `event` label [here](https://github.com/movementlabsxyz/ffs/issues?q=is%3Aissue%20state%3Aopen%20label%3Apriority%3Ahigh%2Cpriority%3Amedium%20label%3Aevent%20). These issues mark upcoming events with a planned date for completion and thus a focus of active development. The events will also be sequenced.
13+
2. **Identify relevant release Candidates:** one or more release candidates will be linked to an event as sub-issues. Release candidates will entail a feature complete version of the project with a planned date for completion. The date for completion may be after the event date if the event features rolling releases. You can check all release candidates [here](https://github.com/movementlabsxyz/ffs/issues?q=is%3Aissue%20state%3Aopen%20label%3Arelease-candidate).
14+
3. **Identify high-priority Features and Bugs:** after you've selected your release candidate, review it's sub-issues for potential `feature` and `bug` requests. You check all `priority:urgent` and `priority:high` issues tagged with `feature` or `bug` label [here](https://github.com/movementlabsxyz/ffs/issues?q=is%3Aissue%20state%3Aopen%20label%3Afeature%2Cbug%20label%3Apriority%3Aurgent%2Cpriority%3Ahigh%20).
15+
16+
**New contributors** should prioritize issues tagged with `bug`.
17+
18+
**Experienced contributors** should prioritize issues tagged with `feature` and facilitate the onboarding of new contributors to bug fixes.
19+
20+
Those looking to add to the suggest new `features` and `bugs` should identify whether their idea is suitable by considering the existing release candidates and their sub-issues.

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,10 @@
11
# ffs
22
Movement Labs' Fast Finality Settlement is a proof of stake settlement system.
3+
4+
| Task | Description |
5+
|------|-------------|
6+
| [Upcoming Events](https://github.com/movementlabsxyz/ffs/issues?q=is%3Aissue%20state%3Aopen%20label%3Apriority%3Ahigh%2Cpriority%3Amedium%20label%3Aevent) | High-priority `event` issues with planned completion dates. |
7+
| [Release Candidates](https://github.com/movementlabsxyz/ffs/issues?q=is%3Aissue%20state%3Aopen%20label%3Arelease-candidate) | Feature-complete versions linked to events. |
8+
| [Features & Bugs](https://github.com/movementlabsxyz/ffs/issues?q=is%3Aissue%20state%3Aopen%20label%3Afeature%2Cbug%20label%3Apriority%3Aurgent%2Cpriority%3Ahigh) | High-priority `feature` and `bug` issues. |
9+
10+
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for contribution guidelines.

0 commit comments

Comments
 (0)