Note: This is a repository template. This README serves both as an example for your new repository, and also contains information on how to use the repository template.
This repository is a template for creating new open-source repositories. It contains all the necessary files and documents to ensure that your open-source project is well-organized and follows best practices.
When creating an open-source project, it's important to establish a clear structure and set of guidelines to ensure that the project is maintainable and sustainable. This repository provides a basic template that can be used as a starting point for new projects.
The template includes the following features:
- A basic file structure for organizing code, documentation, and related files
- A CONTRIBUTING.md file with guidelines for contributing to the project
- A CODE_OF_CONDUCT.md file with guidelines for community behavior
- A LICENSE.md file with information about the open-source license that applies to the project
Instructions for getting started with the repository, for e.g.:
- Installation instructions
- Usage instructions
To use this template please follow the steps as below:
- If creating via Self Service Portal (WIP)
- If Creating via GitHub Interface
- Click the "Use this template" button above, select "Create a new repository"
- Give your repository a name, and optionally a description. The owner will always be "SchweizerischeBundesbahnen".
- Set the visibility of your repository to "Public".
- Do not select "Include all branches".
- Click the "Create repository from template" button and you're done!
Links to all relevant documentation files, including:
Choose a license that meets the organization's legal requirements and supports the sharing and modification of the code. Please follow the internal Open Source guidelines while chosing the License. This repository includes two suggested license texts (Apache 2.0 and EPL 2.0). Rename the license you prefer to LICENSE.md and remove the other one.
This project is licensed under [INSERT LICENSE].
Open-source projects thrive on collaboration and contributions from the community. To encourage others to contribute to your project, you should provide clear guidelines on how to get involved.
This repository includes a CONTRIBUTING.md file that outlines how to contribute to the project, including how to submit bug reports, feature requests, and pull requests.
To maintain a high level of code quality and consistency across your project, you should establish coding standards that all contributors should follow.
This repository includes a CODING_STANDARDS.md file that outlines the coding standards that you should follow when contributing to the project.
To ensure that your project is a welcoming and inclusive environment for all contributors, you should establish a good CODE_OF_CONDUCT.md