From ce4348b554e12e58d5252268ca1d41913e38eaf9 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Thu, 27 Aug 2020 08:25:15 +0200 Subject: [PATCH 01/14] Create CONTRIBUTING.md --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..49f69dc2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +# How to contribute From 2e52168ab5f8b81879b98166f7ab347eb820ee59 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Thu, 27 Aug 2020 08:54:36 +0200 Subject: [PATCH 02/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 49f69dc2..3ebad5a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,30 @@ # How to contribute + +First off, thanks for taking the time to contribute! πŸŽ‰πŸ‘πŸŽ‰πŸ‘πŸŽ‰ + +The following is a set of guidelines for contributing this project. +These are mostly guidelines, not rules. +Use your best judgment, and feel free to propose changes to this document in a pull request. + +When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the repository owner before making a change. + + + +### 🐞 You found a bug or have an issue? + +1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues](issues). +2. Create a [new issue](issues/new) with a **clear and descriptive title** +3. Write a **detailed comment** with as much relevant information as possible including + - *how to reproduce* the bug + - a *code sample* or an *executable test case* demonstrating the expected behavior that is not occurring + - any *files that could help* trace it down (i.e. logs) + +### 🩹 You wrote a patch that fixes an issue? + +1. Open a [new pull request (PR)](pulls) with the patch. +2. Ensure the PR description clearly describes the problem and solution. +3. Link the relevant **issue** if applicable ([how to link issues in PRs](https://docs.github.com/en/github/writing-on-github/autolinked-references-and-urls)). +4. Ensure that [**no tests are failing**](actions) and **coding conventions** are held +5. Submit the patch and await review. + +### πŸ†• You want to add a new feature? From 78de83bc86611b251df48b04d91380cf04fb502e Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Fri, 28 Aug 2020 09:02:17 +0200 Subject: [PATCH 03/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ebad5a0..2b56c88c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,9 @@ # How to contribute -First off, thanks for taking the time to contribute! πŸŽ‰πŸ‘πŸŽ‰πŸ‘πŸŽ‰ + +> First off, thank you for considering contributing to this project. +> It’s [people like you](ref-contributors) that keep this project alive and make it great! +> Thank you! πŸ™πŸ’œπŸŽ‰πŸ‘ The following is a set of guidelines for contributing this project. These are mostly guidelines, not rules. @@ -8,12 +11,12 @@ Use your best judgment, and feel free to propose changes to this document in a p When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the repository owner before making a change. - + ### 🐞 You found a bug or have an issue? -1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues](issues). -2. Create a [new issue](issues/new) with a **clear and descriptive title** +1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues](ref-issues). +2. Create a [new issue](ref-issues-new) with a **clear and descriptive title** 3. Write a **detailed comment** with as much relevant information as possible including - *how to reproduce* the bug - a *code sample* or an *executable test case* demonstrating the expected behavior that is not occurring @@ -21,10 +24,20 @@ When contributing to this repository, please first discuss the change you wish t ### 🩹 You wrote a patch that fixes an issue? -1. Open a [new pull request (PR)](pulls) with the patch. +1. Open a [new pull request (PR)](ref-pull-request-new) with the patch. 2. Ensure the PR description clearly describes the problem and solution. -3. Link the relevant **issue** if applicable ([how to link issues in PRs](https://docs.github.com/en/github/writing-on-github/autolinked-references-and-urls)). -4. Ensure that [**no tests are failing**](actions) and **coding conventions** are held +3. Link the relevant **issue** if applicable ([how to link issues in PRs](ref-pull-request-how-to)). +4. Ensure that [**no tests are failing**](ref-gh-actions) and **coding conventions** are held 5. Submit the patch and await review. ### πŸ†• You want to add a new feature? + + + + +[ref-contributors]: https://github.com/fireblade-engine/ecs/graphs/contributors +[ref-gh-actions]: https://github.com/fireblade-engine/ecs/actions +[ref-issues-new]: https://github.com/fireblade-engine/ecs/issues/new/choose +[ref-issues]: https://github.com/fireblade-engine/ecs/issues +[ref-pull-request-how-to]: https://docs.github.com/en/github/writing-on-github/autolinked-references-and-urls +[ref-pull-request-new]: https://github.com/fireblade-engine/ecs/compare From f56e6a87b07173ee3dbbe90585181fb252c73659 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Fri, 28 Aug 2020 09:06:05 +0200 Subject: [PATCH 04/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b56c88c..9892cf4d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ > First off, thank you for considering contributing to this project. -> It’s [people like you](ref-contributors) that keep this project alive and make it great! +> It’s [people like you][ref-contributors] that keep this project alive and make it great! > Thank you! πŸ™πŸ’œπŸŽ‰πŸ‘ The following is a set of guidelines for contributing this project. @@ -11,12 +11,12 @@ Use your best judgment, and feel free to propose changes to this document in a p When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the repository owner before making a change. - + ### 🐞 You found a bug or have an issue? -1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues](ref-issues). -2. Create a [new issue](ref-issues-new) with a **clear and descriptive title** +1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues][ref-issues]. +2. Create a [new issue][ref-issues-new] with a **clear and descriptive title** 3. Write a **detailed comment** with as much relevant information as possible including - *how to reproduce* the bug - a *code sample* or an *executable test case* demonstrating the expected behavior that is not occurring @@ -24,10 +24,10 @@ When contributing to this repository, please first discuss the change you wish t ### 🩹 You wrote a patch that fixes an issue? -1. Open a [new pull request (PR)](ref-pull-request-new) with the patch. +1. Open a [new pull request (PR)][ref-pull-request-new] with the patch. 2. Ensure the PR description clearly describes the problem and solution. -3. Link the relevant **issue** if applicable ([how to link issues in PRs](ref-pull-request-how-to)). -4. Ensure that [**no tests are failing**](ref-gh-actions) and **coding conventions** are held +3. Link the relevant **issue** if applicable ([how to link issues in PRs][ref-pull-request-how-to]). +4. Ensure that [**no tests are failing**][ref-gh-actions] and **coding conventions** are held 5. Submit the patch and await review. ### πŸ†• You want to add a new feature? @@ -35,6 +35,7 @@ When contributing to this repository, please first discuss the change you wish t +[ref-code-of-conduct]: t.b.d. [ref-contributors]: https://github.com/fireblade-engine/ecs/graphs/contributors [ref-gh-actions]: https://github.com/fireblade-engine/ecs/actions [ref-issues-new]: https://github.com/fireblade-engine/ecs/issues/new/choose From 40bc49d6e898b801375168d7d7940abc60e0461c Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Fri, 28 Aug 2020 09:13:00 +0200 Subject: [PATCH 05/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9892cf4d..f0957120 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# How to contribute +# πŸ’ Contributing to this project > First off, thank you for considering contributing to this project. @@ -13,7 +13,7 @@ When contributing to this repository, please first discuss the change you wish t -### 🐞 You found a bug or have an issue? +### 🐞 You want to file a bug or found an issue? 1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues][ref-issues]. 2. Create a [new issue][ref-issues-new] with a **clear and descriptive title** @@ -30,7 +30,12 @@ When contributing to this repository, please first discuss the change you wish t 4. Ensure that [**no tests are failing**][ref-gh-actions] and **coding conventions** are held 5. Submit the patch and await review. -### πŸ†• You want to add a new feature? +### πŸ†• You want to suggest a new feature? + + + +### βš™οΈ How to set up the environment and run tests + From f44f7f819a9d149dc2b008732a5d379d4dda95a8 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Fri, 28 Aug 2020 09:22:50 +0200 Subject: [PATCH 06/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f0957120..bee1f4a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,11 +9,18 @@ The following is a set of guidelines for contributing this project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. -When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the repository owner before making a change. +### πŸ’‘ Your contribution + +This is an open source project and we love to receive contributions from our community β€” [**you**][ref-contributors]! + +There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or +writing code which can be incorporated into the repository itself. + +When contributing to this project, please feel free to discuss the change you wish to make via issue with the repository owners before making a change. -### 🐞 You want to file a bug or found an issue? +### 🐞 You want to report a bug or file an issue? 1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues][ref-issues]. 2. Create a [new issue][ref-issues-new] with a **clear and descriptive title** From a8d4bee5a65b2f496a765adbbcbf3317abeedf3a Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Fri, 28 Aug 2020 09:26:36 +0200 Subject: [PATCH 07/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bee1f4a9..187dec01 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,16 +5,15 @@ > It’s [people like you][ref-contributors] that keep this project alive and make it great! > Thank you! πŸ™πŸ’œπŸŽ‰πŸ‘ -The following is a set of guidelines for contributing this project. -These are mostly guidelines, not rules. -Use your best judgment, and feel free to propose changes to this document in a pull request. +The following is a set of **guidelines for contributing** to this project. +Use your best judgment and feel free to propose changes to this document in a pull request. -### πŸ’‘ Your contribution +### πŸ’‘ Your contribution - the sky is the limit 🌈 This is an open source project and we love to receive contributions from our community β€” [**you**][ref-contributors]! -There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or -writing code which can be incorporated into the repository itself. +There are many ways to contribute, from writing __tutorials__ or __blog posts__, improving the [__documentation__][ref-documentation], submitting __bug reports__ and __feature requests__ or +__writing code__ which can be incorporated into the repository itself. When contributing to this project, please feel free to discuss the change you wish to make via issue with the repository owners before making a change. @@ -54,3 +53,4 @@ When contributing to this project, please feel free to discuss the change you wi [ref-issues]: https://github.com/fireblade-engine/ecs/issues [ref-pull-request-how-to]: https://docs.github.com/en/github/writing-on-github/autolinked-references-and-urls [ref-pull-request-new]: https://github.com/fireblade-engine/ecs/compare +[ref-documentation]: https://github.com/fireblade-engine/ecs/wiki From 075a70141758b432fb18c3795e21b2d9b979d446 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Fri, 28 Aug 2020 09:39:43 +0200 Subject: [PATCH 08/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 187dec01..73123b87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,11 +33,19 @@ When contributing to this project, please feel free to discuss the change you wi 1. Open a [new pull request (PR)][ref-pull-request-new] with the patch. 2. Ensure the PR description clearly describes the problem and solution. 3. Link the relevant **issue** if applicable ([how to link issues in PRs][ref-pull-request-how-to]). -4. Ensure that [**no tests are failing**][ref-gh-actions] and **coding conventions** are held +4. Ensure that [**no tests are failing**][ref-gh-actions] and **coding conventions** are met 5. Submit the patch and await review. ### πŸ†• You want to suggest a new feature? +#### β˜‘οΈ Your responsibilities + +- [x] Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback. +- [x] Ensure (cross-)platform compatibility for every change that's accepted. An addition should not reduce the number of platforms that the project supports. +- [x] Ensure **coding conventions** are met. Lint your code with the project's default tools. +- [x] Add tests for your feature that proove it's working as expected. Code coverage should not drop below it's previous value. +- [x] Ensure none of the existing tests are failing after adding your changes. +- [x] Document your public API code and ensure to add code comments where necessary. ### βš™οΈ How to set up the environment and run tests From acc17d51506060c075a3c5ecb3f8e055e7232332 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Fri, 28 Aug 2020 10:10:40 +0200 Subject: [PATCH 09/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73123b87..4737f732 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,8 @@ The following is a set of **guidelines for contributing** to this project. Use your best judgment and feel free to propose changes to this document in a pull request. +**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) + ### πŸ’‘ Your contribution - the sky is the limit 🌈 This is an open source project and we love to receive contributions from our community β€” [**you**][ref-contributors]! @@ -36,9 +38,33 @@ When contributing to this project, please feel free to discuss the change you wi 4. Ensure that [**no tests are failing**][ref-gh-actions] and **coding conventions** are met 5. Submit the patch and await review. -### πŸ†• You want to suggest a new feature? +### 🎁 You want to suggest or contribute a new feature? + +That's great, thank you! You rock 🀘 + +If you want to deep dive and help out with development on this project, then first get the project installed locally. +After that is done we suggest you have a look at tickets in our [issue tracker][ref-issues]. +You can start by looking through the beginner or help-wanted issues: +- [__Good first issues__][ref-issue-first] are issues which should only require a few lines of code, and a test or two. +- [__Help wanted issues__][ref-issue-help] are issues which should be a bit more involved than beginner issues. +These are meant to be a great way to get a smooth start and won't put you in front of the most complex parts of the system. + +If you are up to more challenging tasks with a bigger scope, then there are a set of tickets with a __feature__, __enhancement__ or __improvement__ tag. +These tickets have a general overview and description of the work required to finish. +If you want to start somewhere, this would be a good place to start. +That said, these aren't necessarily the easiest tickets. + +For any new contributions please consider these guidelines: +1. Open a [new pull request (PR)][ref-pull-request-new] with a **clear and descriptive title** +2. Write a **detailed comment** with as much relevant information as possible including: + - What your features is intended to do? + - How it can be used? + - What alternatives where considered? + - Has this feature impact on performance or stability of the project? + +#### β˜‘οΈ Your contribution responsibilities -#### β˜‘οΈ Your responsibilities +Don't be intimidated by these responsibilites, they are easy to meet if you take your time to develop your feature 😌 - [x] Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback. - [x] Ensure (cross-)platform compatibility for every change that's accepted. An addition should not reduce the number of platforms that the project supports. @@ -62,3 +88,5 @@ When contributing to this project, please feel free to discuss the change you wi [ref-pull-request-how-to]: https://docs.github.com/en/github/writing-on-github/autolinked-references-and-urls [ref-pull-request-new]: https://github.com/fireblade-engine/ecs/compare [ref-documentation]: https://github.com/fireblade-engine/ecs/wiki +[ref-issue-first]: https://github.com/fireblade-engine/ecs/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue" +[ref-issue-help]: https://github.com/fireblade-engine/ecs/issues?q=is%3Aopen+is%3Aissue+label%3A"help+wanted" From 3fb2c1afdc8a5a8d75535ab29b6692458bb6db65 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Fri, 28 Aug 2020 10:20:36 +0200 Subject: [PATCH 10/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4737f732..eaf32698 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,9 +26,9 @@ When contributing to this project, please feel free to discuss the change you wi 1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues][ref-issues]. 2. Create a [new issue][ref-issues-new] with a **clear and descriptive title** 3. Write a **detailed comment** with as much relevant information as possible including - - *how to reproduce* the bug - - a *code sample* or an *executable test case* demonstrating the expected behavior that is not occurring - - any *files that could help* trace it down (i.e. logs) + - *how to reproduce* the bug + - a *code sample* or an *executable test case* demonstrating the expected behavior that is not occurring + - any *files that could help* trace it down (i.e. logs) ### 🩹 You wrote a patch that fixes an issue? @@ -42,11 +42,11 @@ When contributing to this project, please feel free to discuss the change you wi That's great, thank you! You rock 🀘 -If you want to deep dive and help out with development on this project, then first get the project installed locally. +If you want to dive deep and help out with development on this project, then first get the project [installed locally][ref-readme]. After that is done we suggest you have a look at tickets in our [issue tracker][ref-issues]. You can start by looking through the beginner or help-wanted issues: -- [__Good first issues__][ref-issue-first] are issues which should only require a few lines of code, and a test or two. -- [__Help wanted issues__][ref-issue-help] are issues which should be a bit more involved than beginner issues. + - [__Good first issues__][ref-issues-first] are issues which should only require a few lines of code, and a test or two. + - [__Help wanted issues__][ref-issues-help] are issues which should be a bit more involved than beginner issues. These are meant to be a great way to get a smooth start and won't put you in front of the most complex parts of the system. If you are up to more challenging tasks with a bigger scope, then there are a set of tickets with a __feature__, __enhancement__ or __improvement__ tag. @@ -57,14 +57,14 @@ That said, these aren't necessarily the easiest tickets. For any new contributions please consider these guidelines: 1. Open a [new pull request (PR)][ref-pull-request-new] with a **clear and descriptive title** 2. Write a **detailed comment** with as much relevant information as possible including: - - What your features is intended to do? + - What your feature is intended to do? - How it can be used? - What alternatives where considered? - Has this feature impact on performance or stability of the project? -#### β˜‘οΈ Your contribution responsibilities +#### Your contribution responsibilities -Don't be intimidated by these responsibilites, they are easy to meet if you take your time to develop your feature 😌 +Don't be intimidated by these responsibilities, they are easy to meet if you take your time to develop your feature 😌 - [x] Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback. - [x] Ensure (cross-)platform compatibility for every change that's accepted. An addition should not reduce the number of platforms that the project supports. @@ -74,19 +74,20 @@ Don't be intimidated by these responsibilites, they are easy to meet if you take - [x] Document your public API code and ensure to add code comments where necessary. -### βš™οΈ How to set up the environment and run tests - +### βš™οΈ How to set up the environment +Please consult the [README][ref-readme] for installation instructions. [ref-code-of-conduct]: t.b.d. [ref-contributors]: https://github.com/fireblade-engine/ecs/graphs/contributors +[ref-documentation]: https://github.com/fireblade-engine/ecs/wiki [ref-gh-actions]: https://github.com/fireblade-engine/ecs/actions +[ref-issues-first]: https://github.com/fireblade-engine/ecs/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue" +[ref-issues-help]: https://github.com/fireblade-engine/ecs/issues?q=is%3Aopen+is%3Aissue+label%3A"help+wanted" [ref-issues-new]: https://github.com/fireblade-engine/ecs/issues/new/choose [ref-issues]: https://github.com/fireblade-engine/ecs/issues [ref-pull-request-how-to]: https://docs.github.com/en/github/writing-on-github/autolinked-references-and-urls [ref-pull-request-new]: https://github.com/fireblade-engine/ecs/compare -[ref-documentation]: https://github.com/fireblade-engine/ecs/wiki -[ref-issue-first]: https://github.com/fireblade-engine/ecs/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue" -[ref-issue-help]: https://github.com/fireblade-engine/ecs/issues?q=is%3Aopen+is%3Aissue+label%3A"help+wanted" +[ref-readme]: https://github.com/fireblade-engine/ecs/blob/master/README.md From 645d871e62ec8067b405a64913dceff4e39df62b Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Fri, 28 Aug 2020 10:23:19 +0200 Subject: [PATCH 11/14] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eaf32698..b8acc741 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ When contributing to this project, please feel free to discuss the change you wi ### 🐞 You want to report a bug or file an issue? -1. Ensure that is was **not already reported** and is beeing worked on by checking [open issues][ref-issues]. +1. Ensure that it was **not already reported** and is being worked on by checking [open issues][ref-issues]. 2. Create a [new issue][ref-issues-new] with a **clear and descriptive title** 3. Write a **detailed comment** with as much relevant information as possible including - *how to reproduce* the bug @@ -69,7 +69,7 @@ Don't be intimidated by these responsibilities, they are easy to meet if you tak - [x] Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback. - [x] Ensure (cross-)platform compatibility for every change that's accepted. An addition should not reduce the number of platforms that the project supports. - [x] Ensure **coding conventions** are met. Lint your code with the project's default tools. -- [x] Add tests for your feature that proove it's working as expected. Code coverage should not drop below it's previous value. +- [x] Add tests for your feature that prove it's working as expected. Code coverage should not drop below its previous value. - [x] Ensure none of the existing tests are failing after adding your changes. - [x] Document your public API code and ensure to add code comments where necessary. From e38840d291d9aee6b20a46f26d4551a21ea5a3f9 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Fri, 28 Aug 2020 10:31:20 +0200 Subject: [PATCH 12/14] Update actions --- .github/workflows/ci.yml | 4 ++-- .github/workflows/documentation.yml | 2 +- .github/workflows/markdown-link-check.yml | 7 +++++-- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 39ec5274..629f66f8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -26,7 +26,7 @@ jobs: - name: Generate coverage report run: xcrun llvm-cov export -format="lcov" .build/debug/*PackageTests.xctest/Contents/MacOS/*PackageTests -instr-profile .build/debug/codecov/default.profdata > coverage.lcov - name: Upload code coverage report - uses: codecov/codecov-action@v1 + uses: codecov/codecov-action@master with: token: ${{secrets.CODECOV_TOKEN}} file: coverage.lcov @@ -59,7 +59,7 @@ jobs: - name: Generate coverage report run: llvm-cov export -format="lcov" .build/debug/*PackageTests.xctest -instr-profile .build/debug/codecov/default.profdata > coverage.lcov - name: Upload code coverage report - uses: codecov/codecov-action@v1 + uses: codecov/codecov-action@master with: token: ${{secrets.CODECOV_TOKEN}} file: coverage.lcov diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 19513b04..ed63bdb3 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -17,7 +17,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@master - name: Generate documentation uses: SwiftDocOrg/swift-doc@master with: diff --git a/.github/workflows/markdown-link-check.yml b/.github/workflows/markdown-link-check.yml index 2932cef4..5bb33b4e 100644 --- a/.github/workflows/markdown-link-check.yml +++ b/.github/workflows/markdown-link-check.yml @@ -6,5 +6,8 @@ jobs: markdown-link-check: runs-on: ubuntu-latest steps: - - uses: actions/checkout@master - - uses: gaurav-nelson/github-action-markdown-link-check@v1 + - name: Checkout + uses: actions/checkout@master + - name: markdown-link-check + uses: gaurav-nelson/github-action-markdown-link-check@master + From a1e621d8d96ac0d5cf7a05f4a0219ee263d6d866 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Fri, 28 Aug 2020 10:55:44 +0200 Subject: [PATCH 13/14] Update Makefile --- Makefile | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index f30b7b39..23d0a326 100644 --- a/Makefile +++ b/Makefile @@ -55,13 +55,21 @@ cleanArtifacts: testReadme: markdown-link-check -p -v ./README.md -setupEnvironment: - brew update +generateCode: + sourcery --config ./.sourcery.yml --verbose +generateTestsCode: + sourcery --config ./.sourceryTests.yml --verbose + +brewInstallDeps: brewUpdate brew install swiftenv brew install swiftlint brew install sourcery -generateCode: - sourcery --config ./.sourcery.yml --verbose -generateTestsCode: - sourcery --config ./.sourceryTests.yml --verbose \ No newline at end of file +brewSetup: + which -s brew || /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" + +brewUpdate: brewSetup + brew update + +setupEnvironment: brewInstallDeps + open Package.swift From 1bf4270711030ecf9fcdeacd168c27af3b52bebb Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Fri, 28 Aug 2020 10:55:54 +0200 Subject: [PATCH 14/14] Update README --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9af39d30..8e52c72a 100644 --- a/README.md +++ b/README.md @@ -233,15 +233,22 @@ See the [Fireblade ECS Demo App](https://github.com/fireblade-engine/ecs-demo) t Consult the [wiki](https://github.com/fireblade-engine/ecs/wiki) for in-depth [documentation](https://github.com/fireblade-engine/ecs/wiki). -## 🏷️ Versioning -We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/fireblade-engine/ecs/tags). +## πŸ’ How to contribute -## ✍️ Authors +If you want to contribute please see the [CONTRIBUTION GUIDE](CONTRIBUTING.md) first. -* [Christian Treffs](https://github.com/ctreffs) - *Initial work* -* [Manuel Weidmann](https://github.com/vyo) +To start your project contribution run these in your command line: +1. `git clone git@github.com:fireblade-engine/ecs.git fireblade-ecs` +2. `cd fireblade-ecs` +3. `make setupEnvironment` + +Before commiting code please ensure to run: + +- `make precommit` + +This project is currently maintained by [Christian Treffs](https://github.com/ctreffs). See also the list of [contributors](https://github.com/fireblade-engine/ecs/contributors) who participated in this project. ## πŸ” License