search

TheAlgorithms / Solidity

Algorithms and data structures implemented in Solidity
GNU Lesser General Public License v2.1
326 stars 88 forks source link

[DOCS] Use Markdown formatting #28

Closed Panquesito7 closed 1 year ago

Panquesito7 commented 2 years ago

Description

In the author field when documenting the algorithms, we should use Markdown formatting. For example:

/**
 * @author [David Leal](https://github.com/Panquesito7)
 */

There are many files that currently do not use that format. We should use that formatting instead.

Steps to work on this

  1. Fork the repository here
  2. Clone your forked repository using Git.
  3. Make a branch named markdown_formatting.
  4. If you're using an IDE such as VSCode, the work will be done easier. Search for all files including an @author field, and you may change those as explained above.
  5. Stage your changes after you finish, commit, and push.
  6. Make a PR in the Solidity repository. Now you're done! 🎉

The process might be a bit hard and could take a bit of time. Anything you need help with, do let us know here or on our Discord server.

priyda commented 2 years ago

@Panquesito7 , I would like to work on this

Panquesito7 commented 2 years ago

Sure. You've been assigned. 🙂

mastershashank commented 1 year ago

Hello, @Panquesito7 I would like to work on this issue. Can you assign this task to me?

Panquesito7 commented 1 year ago

Hello. @priyda, are you still going to work on this, or do you want @mastershashank to work on it? Thanks. 🙂

priyda commented 1 year ago

I am working on it, will be raising a pull request soon.

priyda commented 1 year ago

Hello. @priyda, are you still going to work on this, or do you want @mastershashank to work on it? Thanks. 🙂

I am working on it, will be raising a pull request soon.

priyda commented 1 year ago

Hello. @priyda, are you still going to work on this, or do you want @mastershashank to work on it? Thanks. 🙂

I am working on it, will be raising a pull request soon.

Hello. @priyda, are you still going to work on this, or do you want @mastershashank to work on it? Thanks. 🙂

Raised a pull request , please review https://github.com/TheAlgorithms/Solidity/pull/48