Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
drcapybara committed Oct 27, 2023
1 parent d4704cb commit 5103bff
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,18 @@ Example prompts:

## Getting Started

Before you begin, ensure you have a **[GitHub](https://github.com/)** account set up.
Before you begin, ensure you have a **[GitHub](https://github.com/)** account set up. Next, check out the **[issues](https://github.com/drcapybara/capyCRYPT/issues)** page. There are several open issues that are waiting for you to tackle! Issues are labelled according to:
-**Anticipated workload**: These labels range from something you could reasonably solve in an afternoon, to large-scale projects that add entirely new functionaltiy to the library.
-**Good first issue**: These are issues that require minimal design work. Examples are provided to help you get started and can largely be built off of directly.
-**Literature**: These are items that can help you gain experience implementing formal specifications (i.e. from journals) into code. They anticiapte an advanced understanding of cryptographic topics, but are still great for someone without industry experience.
-**Feature vs. Fix**: Add new functionality to the library, or help us fix something! These labels are standard in industry and will give you a good sense of how issues are prioritized in industry.

ASK QUESTIONS about topics you don't understand. Don't let your brain scare you away from denser looking issues! We are here to help at every step. When you find something you want to work on, proceed with the following steps:

1. **Fork** the repository by clicking the "Fork" button at the top-right corner of the original repository page.
2. **Clone** your forked version of the repository to your local machine:
```sh
git clone https://github.com/your-username/capyCRYPT.git
cd capyCRYPT
```
3. Open the repository in your IDE of choice. Assuming you've selected an issue to tackle, create a new branch by using this format:
- Issues labeled "feature" should have the branch named "feature/issue-#"
Expand Down

0 comments on commit 5103bff

Please sign in to comment.