You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,23 @@
1
-
# Contributing to Network Train Simulator (ShipNetSim)
1
+
# Contributing to Ship Network Simulator (ShipNetSim)
2
2
3
3
Thank you for your interest in contributing to ShipNetSim! We welcome contributions from everyone, and we appreciate your help in improving the software.
4
4
5
5
## Getting Started
6
6
7
7
Before you start contributing to ShipNetSim, please follow these steps:
8
8
9
-
1. Familiarize yourself with our Contributor Licensing Agreement (CLA), which is a prerequisite for contributing to our project. Please read and sign the CLA [here](https://cla-assistant.io/AhmedAredah/ShipNetSim).
10
-
2. Check the [issue tracker](https://github.com/AhmedAredah/ShipNetSim/issues) for open issues that you could work on. If you have an idea for a new feature or improvement, please create a new issue to discuss it first.
9
+
1. Familiarize yourself with our Contributor Licensing Agreement (CLA), which is a prerequisite for contributing to our project. Please read and sign the CLA [here](https://cla-assistant.io/VTTI-CSM/ShipNetSim).
10
+
2. Check the [issue tracker](https://github.com/VTTI-CSM/ShipNetSim/issues) for open issues that you could work on. If you have an idea for a new feature or improvement, please create a new issue to discuss it first.
11
11
3. Fork the ShipNetSim repository to your GitHub account.
12
12
4. Clone the forked repository to your local machine.
13
-
5. Install the required software dependencies. See the README file for more information.
13
+
5. Install the required software dependencies. See the [HOW_TO_BUILD.md](HOW_TO_BUILD.md) file for detailed build instructions.
14
14
6. Create a new branch for your changes. Please use a descriptive branch name that reflects the changes you are making.
15
15
7. Make your changes to the code, documentation, or other project files.
16
16
8. Test your changes thoroughly to ensure they work as intended.
17
17
9. Commit your changes with clear and concise commit messages.
18
18
10. Push your changes to your forked repository.
19
19
11. Submit a pull request to the ShipNetSim repository with a clear description of your changes.
20
-
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)
20
+
12. If you want your name to be added to the contributing list, kindly refer to the following [all-contributors documentation](https://allcontributors.org/docs/en/bot/usage).
21
21
22
22
## Guidelines
23
23
@@ -34,8 +34,8 @@ When contributing to ShipNetSim, please follow these guidelines:
34
34
35
35
## Code of Conduct
36
36
37
-
ShipNetSim is committed to providing a welcoming and inclusive environment for all contributors and users. Please read the [CODE_OF_CONDUCT.md](https://github.com/AhmedAredah/ShipNetSim/blob/main/CODE_OF_CONDUCT.md) file for more information.
37
+
ShipNetSim is committed to providing a welcoming and inclusive environment for all contributors and users. Please read the [CODE_OF_CONDUCT.md](https://github.com/VTTI-CSM/ShipNetSim/blob/main/CODE_OF_CONDUCT.md) file for more information.
38
38
39
39
## License
40
40
41
-
By contributing to ShipNetSim, you agree to license your contributions under the GPL3.0 License. See the [LICENSE](https://github.com/AhmedAredah/ShipNetSim/blob/main/LICENSE) file for more information.
41
+
By contributing to ShipNetSim, you agree to license your contributions under the GPL-3.0 License. See the [LICENSE](https://github.com/VTTI-CSM/ShipNetSim/blob/main/LICENSE) file for more information.
0 commit comments