Update README, CONTRIBUTING and templates

This commit is contained in:
Leonardo committed 2019-04-04 18:35:00 -03:00
1 parent 2d533c2db5
commit 2b18531478
4 files changed
+27 -17

No files matched your search

+1 -1
View File
@@ -4,7 +4,7 @@
A clear and concise description of what the bug is.
### To Reproduce
### How to Reproduce
Steps to reproduce the behavior:
+6
View File
@@ -1,5 +1,11 @@
# Feature Request Template
### What is the nature of this request?
* New functionalities
* Change in standards
* Change in source code details (names of variables, functions, parameters, etc)
### Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+6 -2
View File
@@ -2,11 +2,15 @@
Two simple steps:
* Fork this repository
* Fork this repository to your github account
* Clone it to your machine
Now you can start working on the project.
## Open Issues
Check out `bug_report.md` and `feature_request.md` templates in the `.github` folder to know how to make a bug report or feature request.
## Here are things you could work on:
1. New features, new functions, new stuff!
@@ -34,7 +38,7 @@ Now you can start working on the project.
4. All source files (`.c`, `.h`, etc) must contain a header with the following template:
* Complete file name.
* First commit date in `dd/mm/yyyy`.
* Authors name with (optional) github link to his page.
* Authors name with (optional) link to github page.
```
/**
+14 -14
View File
@@ -21,6 +21,20 @@ Generate Simple Data Structures of any type in C for you to use in your projects
Check out **Documentation.md** for more information about each data structure.
## What to use
The following table shows how each data structure is implemented and how well they do when using as common [abstract data types](https://en.wikipedia.org/wiki/Abstract_data_type).
* **Ideal** - The data structure implements correctly the abstract data type;
* **Not Ideal** - The implementation is fulfilled but some functionalities are either not part of the ADT or not present;
* **Bad** - It can be done, but its a bad idea.
![DataStructuresDiagram](https://i.imgur.com/hFqBSlC.png)
![GoodColor](https://img.shields.io/badge/Ideal_Implementation-%236abf69.svg)
![AverageColor](https://img.shields.io/badge/Not_Ideal_Implementation-%2363a4ff.svg)
![BadColor](https://img.shields.io/badge/Bad_Implementation-%23ff6659.svg)
## How to use
To generate the data structures, all you need to do is to include the necessary header files. You can include the containers you want to use individually or you can include the master header, `macro_collections.h`, that comes with all collections and other functionalities like the `FOR_EACH` macro.
@@ -159,17 +173,3 @@ gcc source.o main.o
```
The container members won't be visible to the file `main.c`. For this to work, all parameters must be identical, with the only difference being the macro name.
## What to use
The following table shows how each data structure is implemented and how well they do when using as common [abstract data types](https://en.wikipedia.org/wiki/Abstract_data_type).
* **Ideal** - The data structure implements correctly the abstract data type;
* **Not Ideal** - The implementation is fulfilled but some functionalities are either not part of the ADT or not present;
* **Bad** - It can be done, but its a bad idea.
![DataStructuresDiagram](https://i.imgur.com/hFqBSlC.png)
![GoodColor](https://img.shields.io/badge/Ideal_Implementation-%236abf69.svg)
![AverageColor](https://img.shields.io/badge/Not_Ideal_Implementation-%2363a4ff.svg)
![BadColor](https://img.shields.io/badge/Bad_Implementation-%23ff6659.svg)