From 4c6b40344087df193ed59b36dbec900b0d994f04 Mon Sep 17 00:00:00 2001 From: Ahmed Aredah <77444744+AhmedAredah@users.noreply.github.com> Date: Wed, 14 Jun 2023 10:50:40 -0400 Subject: [PATCH 1/4] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 32 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..4e5d4f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: BUG +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Version [e.g. 22] + + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..11fc491 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**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 [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From 16f2834a149fafff2b993d209547db4755671011 Mon Sep 17 00:00:00 2001 From: Ahmed Aredah <77444744+AhmedAredah@users.noreply.github.com> Date: Thu, 15 Jun 2023 10:11:54 -0400 Subject: [PATCH 2/4] Update README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index fa20493..698e7e3 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,18 @@ The development of NeTrainSim has been a collaborative effort. The following ind - Fellow of the Canadian Academy of Engineering - Fellow of IEEE +## Contributors + + + + + + + + + + + ## Contributing If you are interested in contributing to NeTrainSim, please read the CONTRIBUTING.md file for more information on how to get started. From 40707e943c8b5695020253800a9fa60d66f3ef72 Mon Sep 17 00:00:00 2001 From: Ahmed Aredah <77444744+AhmedAredah@users.noreply.github.com> Date: Thu, 15 Jun 2023 10:13:19 -0400 Subject: [PATCH 3/4] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 698e7e3..8a9671a 100644 --- a/README.md +++ b/README.md @@ -171,7 +171,6 @@ The development of NeTrainSim has been a collaborative effort. The following ind - ## Contributing If you are interested in contributing to NeTrainSim, please read the CONTRIBUTING.md file for more information on how to get started. From ead50138362ae063332ca06388bee800ee1e731b Mon Sep 17 00:00:00 2001 From: Ahmed Aredah <77444744+AhmedAredah@users.noreply.github.com> Date: Thu, 15 Jun 2023 10:32:45 -0400 Subject: [PATCH 4/4] Update and rename Contribute.md to CONTRIBUTING.md --- Contribute.md => CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) rename Contribute.md => CONTRIBUTING.md (93%) diff --git a/Contribute.md b/CONTRIBUTING.md similarity index 93% rename from Contribute.md rename to CONTRIBUTING.md index a42d43f..74dd115 100644 --- a/Contribute.md +++ b/CONTRIBUTING.md @@ -17,6 +17,7 @@ Before you start contributing to NeTrainSim, please follow these steps: 9. Commit your changes with clear and concise commit messages. 10. Push your changes to your forked repository. 11. Submit a pull request to the NeTrainSim repository with a clear description of your changes. +12. If you want your name to be added to the contributing list, kindly refer to the following [allcontributors docmentation.](https://allcontributors.org/docs/en/bot/usage) ## Guidelines