Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.36 KB
Raw

Contributors Guide

basecamp is an open-source Cairo/StarkNet teaching curriculum written by starknet-edu. We welcome all contributions to this repository to help enrich the StarkNet community.

How to Contribute

We operate and maintain this project with an issue and pull request model. We will track the GitHub issues section Issues of this repository and contributors can submit Pull Requests for review by the maintainers.

Style Guide

  • when naming a subdirectory use "snake_case" and do not use acronyms

General Work-Flow

We recommend the following work-flow for contributors:

  1. Find an issue to work on and use comments to communciate your intentions and ask questions.
  2. Work in a feature branch of your personal fork (github.com/YOUR_NAME/basecamp) of the main repository (github.com/starknet-edu/basecamp).
  3. After you have implemented or resolved the issue, create a pull-request to merge your changes in the main repository
  4. Wait for the repository maintainers to review your changes to ensure the issue is addressed.
  5. If the issue is addressed the repository maintainers will merge your pull-request

Helpful Article on contribution

guide