Skip to content

Commit

Permalink
contributing details
Browse files Browse the repository at this point in the history
  • Loading branch information
drspacemn committed Jan 19, 2024
1 parent f08b671 commit 942bb5f
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: {{ env.GITHUB_BASE_REF }}
---
<!--TODO does env need to be changed?-->

Issue Number: N/A
Breaking Change: [ ] <!-- [x] if breaking -->

Expand Down
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## 🛠️ Contributing to Blobstream-SN 🛠️

Welcome, welcome, contributing to blobstream-sn is easy!

1. Submit or comment your intent on an issue
2. We will try to respond quickly
3. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this repository and develop
4. Submit your PR against `main`
5. Address PR Review

### Issue

Project tracking is done via GitHub [issues](https://github.com/keep-starknet-strange/blobstream-sn/issues).
First look at open issues to see if your request is already submitted. If it is comment on the issue requesting assignment,
if not open an issue.

We use 3 issue [labels](https://github.com/keep-starknet-strange/blobstream-sn/issues/new):

> `feat:`, `bug:`, `dev:`
Your branch must be prefixed in the following issue map (`type`, `title:`, `branch-prefix/`):

- `Feature request` -> `feat:` -> `feat/{issue #}-{issue name}`
- `Bug report` -> `bug:` -> `bug/{issue #}-{issue name}`
- `Codebase improvement` -> -> `dev:` -> `dev/{issue #}-{issue name}`

#### Bug Reports
Please try to create bug reports that are:

- _Reproducible._ Include steps to reproduce the problem.
- _Specific._ Include as much detail as possible: which version, what environment, etc.
- _Unique._ Do not duplicate existing opened issues.
- _Scoped to a Single Bug._ One bug per report.

### Submit PR

Ensure your code is well formatted, well tested and well documented. A core contributor
will review your work. Address changes, ensure ci passes, and voilà you're a blobstream-sn contributor.

General info on [syncing a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork).

***ping the [TG](https://t.me/+N7UqCg2hxA4wNTZh) for questions***

---

Thank you for your contribution!

0 comments on commit 942bb5f

Please sign in to comment.