This project offers a template that can be used by anyone willing to create a new project based on resources that are commonly used in Open Source projects.

It is a template, but at the same time contains the information of the project itself, so it is itself an example of its application.

Despite of the title, it should work either for InnerSource or Open Source projects. Of course it is far from being perfect nor complete, it is just one possible approach. So, it is open to modifications either on your side or by proposing changes to this template via Pull Request. Something that is useful for you, can also be useful for others.

Please note that italic texts are directions on how to use this template.

This file is the standard entry point for newcomers, so make sure you keep it small, understandable and straight-forward. Point to other more detailed resources as needed.

In order to just use (download) this repo you don't need to install any tool. Not even git!

Within this project you'll find the following documents:

• For users:
  • Project basic description (this document) is the single standard entry point.
  • The project license rules what you are legally allowed to do with it.
  • And finally you'll need to know how to install/use this project.
• For contributors:
  • In addition to users documentation...
  • Here's a guide for your first contributions.
  • The formal Contribution guidelines rule the contribution process, which conceptually includes the Code Review Process.
  • At some point you may want to know how to become a Trusted Commiter.
  • The Governance model describes the organization of social interaction, including the license and the code of conduct (CoC).

The following documentation is tightly related to this project but is not provided along with the source code.

• The open source idea (White paper)
• Introduction to InnerSource (video)

• Learn more about this repository/project following the links in this document. Everything related should be directly or indirectly linked and browsable from here.
• You can learn more about the InnerSource program at Organization link here to your central info point.
• A good place to get more information about InnerSource in general (eg. outside the Organization) is the InnerSourceCommons.

This section explains how to get in touch with the project team. In order to keep it simple, don't describe all possible interactions (There's a Governance model for that), just the first most basic ones...''

For the moment this project is tiny, so communicating with us is simple and basic.

• Users: Just hover the mouse over the contributors to find who are members and contact any of us. Or open an issue.
• Contributors: For deeper interactions, the Governance model should include also pointers to people and communication channels (chat channels, forums, regular meetups, etc), as well as rules, but we're so tiny we don't actually have any of these in this project.
• Other: For any other questions on this project, please contact dicortazar.