Skip to content

Latest commit

 

History

History
104 lines (72 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

104 lines (72 loc) · 3.59 KB

For Contribution in damn_dsa, it is important to record

(1) How the logic is working ,
(2) If new feature is added ,then properly document it,
(3) SUCCESSFULLY BUILD LOCALLY before creating a PR , and
(4) If Theme is changed , make sure it is accessible .

What information should be in the program documentation?

For an individual module, it is important to record
(1) who has written the module,
(2) when the module was written or modified,
(3) why the module was written or modified,
(4) how the module interacts with other modules,
(5) what special algorithms were used, if any, and
(6) acknowledge outside sources for ideas and algorithms.


Follow these steps to Contribute

Step 1. Fork the Repo

image1

Step 2.Go to Issue Section

Rather choose the an Existing Issue or Create A New One
image2

Note: Once you have chosen the path, make sure that the algorithm is not already implemented. This step is very important because we dont't want your time and energy to be go in bin.

Step 3. If Solving an Existing Issue

Make sure your commit is in formal way. For example

Hey @maintainer
I feel confident in solving this issue and please allow me to do so with Hacktoberfest 2022 tag.

Step 3. If Creating a New Issue

Follow up the syntax mention in issue section and delete the rest of comments.

image

Step 4. Create a New File with a Suitable Name

image4

Make sure to follow the relavant name convention image

Step 5. Code up your file with Stated Syntax

Copy this syntax paste it into new file and edit it

    # Problem Statement
    <!-- Write up here -->

<!--
      ## About Problem 
       Difficulty : <!--Easy | Medium | Hard --><br/>
       Problem link: https://github.com/tanuj1811  <br/>  
     -->


    <!--Not mandatory, only if you like to add  else Delete

      ## Intution 
      ## Throught Process
      
      -->

      ## Code 
    ``` <-- Write your Programing Language Name-->
       class Solution {
           public void thanks() {
               if(likeThisRepo) {
                   starTheRepo();
                   makeContributions();
                   tellYourFirend();
               }

               print("Thanks and Happy Coding");        
           }
       }
     ```

Step 6. Commit The File

image6

Step 7. Create PR and PR Message

  • Fill the details and delete the rest. image7

Step 8. Create A Pull Request

image8

Congrats and Wait Till Your PR Gets Merged

image

So what are you waiting for? Go on and start contributing! 😄 May the code be with you 🤘