Skip to content

ækiti Repository Guildlines

Overview

Welcome hackers! It is awesome to have you here! In this guideline you would learn how to contribute to the below repository:

aekiti/hacktoberfest2020

Before you start contributing to this project make sure you have read the repository Code Of Conduct, it is really important to make this inclusive and open to everyone, otherwise, it would not be awesome.

This repository was created to get developers going with Open Source during Hacktoberfest.

Steps

  1. Fork and Clone the repository
  2. Create a new branch
  3. Add your contribution
  4. Add your profile
  5. Commit and push your fork
  6. Create a pull request
  7. Star the repository

How To Contribute

Fork and Clone the repository

Method 1

To fork and clone the repo easily, execute the below GitHub CLI command: 

gh repo fork aekiti/hacktoberfest2020

Method 2

You can also click the Fork button at the right top corner and clone the forked repo using the HTTPS method

Create a new branch

Creating a new branch for your contributions is essential, execute the below Git command to create your branch 

git checkout -b my-branch-name

NOTE: The best way to replace the my-branch-name key in the above command is your GitHub username. E.g: aekiti

Add your contribution

Adding your contributions can be done in 3 ways that are categorized in æpps, ærticles, and dæsigns.

æpps

The æpps categories is where you can add æpps built on æternity blockchain. Follow the below steps to add contributions based on this category:

  1. Locate the contribution/aepps directory
  2. Create a new folder/directory that respresents the æpp name
  3. Add the codes of the æpp in the newly created directory

ærticles

The ærticles categories is where you can add articles based on æternity blockchain, open source, and hacktoberfest. Follow the below steps to add contributions based on this category:

  1. Locate the contribution/aerticles directory
  2. Create a new folder/directory that respresents the ærticle name
  3. Add the ærticle in either pdf, txt or md format in the newly created directory

dæsigns

The designs categories is where you can add designs based on æternity blockchain, open source, and hacktoberfest. Follow the below steps to add contributions based on this category:

  1. Locate the contribution/daesigns directory
  2. Create a new folder/directory that respresents the design name
  3. Add the design in either png, jpg or jpeg format in the newly created directory

Add your profile

This is where you add your profile to showcase your contributions. Below is the step to your profile:

  1. Head to the profile directory.
  2. Create a markdown file with your GitHub username in the profile directory directory: aekiti.md
  3. Copy the below snippet and fill the required field accordingly. 
---
name: FULLNAME-OR-NICKNAME # No longer than 28 characters
institution: INSTITUTION-NAME 🚩 # No longer than 58 characters
type: YOUR-CONTRIBUTION-TYPE # Must be in [æpp, ærticle, dæsign]
link: <TYPE>/<CONTRIBUTION-FOLDER> # Must be your contribution folder location. <TYPE> must be in [aepps, aerticles, daesigns]
github: YOUR-GITHUB-USERNAME # Must be your GitHub Username with the (@) symbol
superhero: YOUR-SUPERHERO-PROFILE-LINK # Must be your Superhero profile link
---

Commit and push your fork

After adding your contributions, stage, commit and push your contribution to your forked repo with the below steps:

  1. Staging Changes 
    git add .
  2. Commiting Changes 
    git commit -m '@username: Commit message'
  3. Pushing Changes 
    git push origin my-branch-name

Create a pull request

With the Step 4, your contributions would now be on your forked GitHub Repo. Now you can submit a new pull request from your forked repository to be merged with main repository by clicking the Compare & pull request button on top of your repo. Then click the Create pull request to create a new pull request

Star the repository

Now that you have contributed to open source, it'd be nice to star this Repository while your contribution awaits review from the team

Resources

Conclusion

Pat yourself on the back and wait for your pull request to be reviewed and merged. If merged, check your Hacktoberfest profile because you have earned another contribution.