Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Blue-Robin-Taken authored Mar 31, 2024
1 parent 1688586 commit 6062be6
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# How to contribute

If you already know how to use the basic Github workflow, you don't need to read further.

## Step one:

Find something to work on. Whether this adds a new feature or fixes something, make an issue first (or find one).

## Step two (optional):

Join the [discord server](https://discord.gg/7sKSGEmXw2). This helps with collaboration and communication.

## Step two point five:

If you don't know how to use basic github CLI, work on that.

## Step three:

After you make that issue (or don't it's totally fine), then start working on your code. The code will be in a fork of the repository that you make. To make a fork, press the fork button above the about section in the repo:
![image](https://github.com/Blue-Robin-Taken/nestling-bot/assets/86581171/357759c7-0129-4c62-bcc6-dff60b508190)

After you feel like your idea is somewhat presentable in code, make a PR in the Pull requests tab above the repository:
![image](https://github.com/Blue-Robin-Taken/nestling-bot/assets/86581171/127d906e-90bb-4324-9449-5e09e631dafa)
(It's the third tab)

A pull request is the thing that allows you to pull your code into the main repository. It also allows other contributors to edit your code so that it'll be well refined once pushed.

## Step four:

Make changes that are needed to the pull request by maintainers. & just wait for it to be added.

0 comments on commit 6062be6

Please sign in to comment.