Skip to content

Commit 05a06a0

Browse files
committed
Minor changes in the contribution guidelines and added to README #39
1 parent b1e8bfc commit 05a06a0

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

CONTRIBUTION.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Contribution guidelines
1+
# Contribution guidelines
22

33
It's great that people want to contribute to Tileson!
44
Here are some guidelines to make sure we keep this a stable library.
@@ -8,6 +8,11 @@ In short this means that I must be aware of an issue and accept it before it can
88
Reason being mainly to make sure the issue actually is a problem and that I retain full control of project and its direction.
99
If the issue is about a potential new feature, it's important that you describe in detail why this feature is needed.
1010

11+
Also: If you are interested in fixing or developing on an existing issue you did not
12+
create yourself, please notify me in the issue before you start working on it, so I
13+
can assign you the task. This is mainly to prevent that two people work on the
14+
same feature.
15+
1116
### 2. Every issue must have a unit test proving that it works
1217
If you have either fixed a bug or created a new feature, you must prove that everything works
1318
as intended by creating a test to prove that the logic works. Additionally,

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,16 @@ maps made with newer versions of Tiled just as well.
1111

1212
Be sure to take a look at the release notes to see what's new!
1313

14-
## Documentation
14+
# Documentation
1515

1616
There is a `Doxygen` generated documentation of Tileson that can be found [HERE](https://ssbmtonberry.github.io/tileson/html)
1717

1818
### IMPORTANT: Tileson requires that everything it needs in a map is embedded into it, to be able to resolve their related objects. Maps having external references to tilesets etc. will not work.
1919

20+
# How to contribute
21+
You are free to post any issue requesting new features, reporting bugs or asking questions at any time.
22+
If you want to contribute in the development of `Tileson`, make sure you read the [CONTRIBUTION GUIDELINES](https://github.com/SSBMTonberry/tileson/blob/master/CONTRIBUTION.md)
23+
before you start doing anything.
2024

2125
# Tileson is header-only!
2226
This means that all you need is one file, `single_include/tileson.hpp` to have Tileson going

0 commit comments

Comments
 (0)