Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 2.72 KB

Contributing to Network Train Simulator (NeTrainSim)

Thank you for your interest in contributing to NeTrainSim! We welcome contributions from everyone, and we appreciate your help in improving the software.

Getting Started

Before you start contributing to NeTrainSim, please follow these steps:

  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.
  2. Check the issue tracker 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.
  3. Fork the NeTrainSim repository to your GitHub account.
  4. Clone the forked repository to your local machine.
  5. Install the required software dependencies. See the README file for more information.
  6. Create a new branch for your changes. Please use a descriptive branch name that reflects the changes you are making.
  7. Make your changes to the code, documentation, or other project files.
  8. Test your changes thoroughly to ensure they work as intended.
  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.

Guidelines

When contributing to NeTrainSim, please follow these guidelines:

  • Be respectful and courteous to other contributors and users.
  • Follow the coding style and conventions used in the existing codebase.
  • Write clear and concise code that is easy to read and understand.
  • Test your changes thoroughly to ensure they work as intended.
  • Document your code and changes as appropriate.
  • Discuss major changes or new features with the project maintainers before starting work.
  • Keep your pull request focused on a specific issue or feature. If you are making multiple changes, please create separate pull requests for each one.
  • Be responsive to feedback from the project maintainers and other contributors.

Code of Conduct

NeTrainSim is committed to providing a welcoming and inclusive environment for all contributors and users. Please read the CODE_OF_CONDUCT.md file for more information.

License

By contributing to NeTrainSim, you agree to license your contributions under the GPL3.0 License. See the LICENSE file for more information.