OpenGenus/cosmos

Adapt consistent format for functions

Open

#5,883 opened on Aug 23, 2020

View on GitHub
 (3 comments) (2 reactions) (0 assignees)C++ (3,724 forks)batch import
Hacktoberfest

Repository metrics

Stars
 (13,462 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

This is a(n):

  • New algorithm
  • Update to an existing algorithm
  • Error
  • Proposal to the Repository

Details:

I propose to adapt a consistent format for functions

 /* Description [What it does]
  *  - 
  * Arguments [The arguments and their type]
  *  - Arg_1 of type_n 
  *  - ...
  *  - - Arg_i of type_m
  * Return Value [What it returns and the type]
  *  -  ...
  *  
  */

This would give the code structure, prevent errors and achieve a specification to develop Hoare proofs for algorithms here.

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.