-
-
Notifications
You must be signed in to change notification settings - Fork 10
/
CONTRIBUTING.md
57 lines (35 loc) · 2.03 KB
/
CONTRIBUTING.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# Contributing
First off I have to thank you for wanting to contributing to this project. You rock 🤘! Please read the process below.
We recently moved to using tables to represent the data here. This [Pull Request](https://github.com/kaf-lamed-beyt/ng-tech-events/pull/35) by [Samuel Peters](https://github.com/Petsamuel) helped us accomplish that.
So the experience of contributing to this repository isn't completely arduous for you, downloading this Vscode extension — [Markdown table prettifier](https://marketplace.visualstudio.com/items?itemName=darkriszty.markdown-table-prettify) — can help reduce the friction of working with tables in markdwon.
Feel free to suggest other extensions that you think may be better than the aforementioned one to.
## Getting Started
Here, you'd find the step-by-step process of contributing to this project, from **(Forking)** to submitting a final pull request. Please do not hesitate to ask questions whenever you feel stuck.
- First, you have to fork this repository. When you do that, you're creating a copy of this repository under your GitHub account.
- Clone the repository (your forked version), by doing this...
```shell
git clone https://github.com/kaf-lamed-beyt/ng-tech-events.git
```
When you're done with the step above, cd (change directory) into the project folder
```shell
cd ng-tech-events
```
- When you're inside the directory of the project, update the [README](README.md) file with the information about of the event you wish to add.
- Set the remote upstream of your forked repository to the base repository (i.e. the original repository)
```shell
git remote add upstream https://github.com/kaf-lamed-beyt/ng-tech-events.git
```
- Create a branch and start working on your feature.
```shell
git checkout -b [branch-name]
```
- Save and commit your changes
```shell
git add --all
git commit -m "your message"
```
- Push to your branch, create a pull request and wait for it to be merged.
```shell
git push origin [branch name]
```
## Happy Hacking! -->