├── PULL_REQUEST_TEMPLATE.md ├── ISSUE_TEMPLATE.md ├── CONTRIBUTING.md └── README.md /PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## What is the purpose of this Pull Request? 2 | 3 | ## Does this Pull Request solve any existent Issue? 4 | -------------------------------------------------------------------------------- /ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## What is the purpose of this Issue? 2 | - Request validation 3 | - Propose changes 4 | - Propose a new Standard 5 | 6 | ## Describe the purpose of this Issue a bit further 7 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to contribute 2 | 3 | Thank you for reading this, it means you are interested in contributing to this initiative which needs the entire community to become useful. 4 | 5 | If you haven't already, come find us on Gitter [Standards/Lobby](https://gitter.im/Standards/Lobby). 6 | 7 | Here are some important resources: 8 | 9 | * Standards homepage at https://openstandards.guide 10 | * Standards Learn section on the homepage at https://openstandards.guide/learn 11 | * Standards Explore section on the homepage at https://openstandards.guide/explore 12 | * Medium article about this initiative by @leog at https://medium.com/@leog/universal-software-standards-ftw-cc4771ef3d3 13 | * Have any concrete suggestion/improvement? Submit an issue on the Meta standard at https://github.com/Standards/meta/issues/new 14 | * Want to propose a new standard to be created? Follow this guide https://openstandards.guide/learn#create-a-new-standard 15 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Meta 3 | description: Standard to create Open Standards 4 | category: user-guide 5 | repository_url: https://github.com/standards/meta 6 | --- 7 | [![badge]](https://github.com/Standards/meta/issues/4) 8 | 9 | [![Backers on Open Collective](https://opencollective.com/openstandards/backers/badge.svg)](#backers) 10 | [![Sponsors on Open Collective](https://opencollective.com/openstandards/sponsors/badge.svg)](#sponsors) 11 | 12 | ## Goals 13 | The development world inside GitHub is vast and full of wonders, with lots people with different ways to conceive a piece of software. Open Source projects can present a huge challenge on how things should be done across scattered teams where common-knowledge distribution is a huge challenge on its own too. 14 | 15 | Every developer comes from different background and can think of a solution in a number of different ways, but in order to be successful there are certain ground rules that should be put in place. 16 | 17 | Being able to create something that followed pre-established conventions we can all agree on basically helps us: 18 | 19 | * Measure quality in some way 20 | * In case of software development, standards would assist a developer in understanding what a piece of software provides in order to facilitate usage 21 | * Provide an understandable and universally accepted way to collaborate on any type of project 22 | * Promote a healthy way to extend any project when collaboration guidelines are followed 23 | * Bring up to speed new comers to a project being able to ramp up reading applied standards 24 | 25 | A project complient with this standard constitutes a standard. 26 | 27 | ## Definition 28 | 29 | ### In a README.md file 30 | 31 | #### Title, description and category 32 | Basic information should be added to the header of the `README.md` file of your standard to identify it. First of all we have the title of the standard that should be meaningful yet short, then a short description. Lastly a category to help searchability (e.g. the targeted programming language) and the resporitory URL where the standard is located. These need to be in the following form: 33 | 34 | ```markdown 35 | --- 36 | title: Meta 37 | description: Standard to create Open Standards 38 | category: user-guide 39 | repository_url: https://github.com/standards/meta 40 | --- 41 | ``` 42 | 43 | #### Goals section 44 | This section should cover why the standard should exist. Always try to include the "A project compliant with this standard..." and examples of the resultant workflow of a compliant project. 45 | 46 | #### Definition section 47 | Which are the specific requirements that should be applied in order to be fully compliant. You can also point out optional requirements with a clear reference of why it is optional. At least there should be one compulsory requirement. 48 | 49 | #### Resources section 50 | Any reference to documentation used to create the standard as well as any appendixes. This is optional as there may not be any resource available to add. 51 | 52 | #### Maintainers section 53 | At least two people, with their correspondent email addresses, responsible for maintaining the standard. Also they could officiate as validators if no validator section is included. Refer to the [Learn section] of the Standards homepage to know more about validators job. 54 | 55 | #### Validator section (optional) 56 | It can be omitted if the people added as "Maintainers" are the ones responsible of fulfilling validators tasks. Otherwise, same requirements, at least two persons with their correspondent email addresses. 57 | 58 | ### Other files 59 | The following files should exist in your repository root or inside a `.github` folder: 60 | 61 | #### `ISSUE_TEMPLATE.md` file 62 | With the following content: 63 | 64 | ```markdown 65 | ## What is the purpose of this Issue? 66 | - Request validation (title must be "Validate owner/repo-name vX.Y.Z" being owner/repo the repository location to validate and vX.Y.Z the standard version complied) 67 | - Propose changes 68 | - Propose a new Standard 69 | 70 | ## Describe the purpose of this Issue a bit further 71 | ``` 72 | 73 | #### `PULL_REQUEST_TEMPLATE.md` 74 | With the following content: 75 | 76 | ```markdown 77 | ## What is the purpose of this Pull Request? 78 | 79 | ## Does this Pull Request solve any existent Issue? 80 | ``` 81 | 82 | ## Resources 83 | 84 | * [Explore section] of the Standards homepage: Where you can explore all existing standards. 85 | * [Learn section] of the Standards homepage: Information to understand how you can submit a new standard, propose changes to existing ones or request validation for applied standards on your projects. 86 | 87 | ## Maintainers 88 | 89 | 1. [@leog](https://github.com/leog) 90 | 2. [@olstenlarck](https://github.com/olstenlarck) 91 | 92 | [Explore section]: https://openstandards.guide/explore 93 | [Learn section]: https://openstandards.guide/learn 94 | [badge]: https://open-standards.now.sh/api/badge/standards/meta/4 95 | 96 | ## Contributors 97 | This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. 98 | 99 | 100 | ## Backers 101 | Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/openstandards#backer)] 102 | 103 | 104 | 105 | ## Sponsors 106 | Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/openstandards#sponsor)] 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | --------------------------------------------------------------------------------