├── CONTRIBUTING-template.md ├── LICENSE └── README.md /CONTRIBUTING-template.md: -------------------------------------------------------------------------------- 1 | # Introduction 2 | 3 | ### Write something nice here! 4 | 5 | >First off, thank you for considering contributing to Active Admin. It's people like you that make Active Admin such a great tool. 6 | 7 | [source: [Active Admin](https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md)] **Need more inspiration?** [1] [Read The Docs](http://read-the-docs.readthedocs.org/en/latest/contribute.html) [2] [Mustache.js](https://github.com/janl/mustache.js/#contributing) 8 | 9 | ### Tell them why they should read your guidelines. 10 | 11 | >Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. 12 | 13 | [source: [Hoodie](https://github.com/hoodiehq/hoodie/blob/master/CONTRIBUTING.md)] 14 | 15 | ### Explain what kinds of contributions you are looking for. 16 | 17 | Keep an open mind! Improving documentation, bug triaging, or writing tutorials are all examples of helpful contributions that mean less work for you. 18 | 19 | > Elasticsearch is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Elasticsearch itself. 20 | 21 | [source: [Elasticsearch](https://github.com/elastic/elasticsearch/blob/master/CONTRIBUTING.md)] **Need more inspiration?** [1] [Devise](https://github.com/plataformatec/devise/wiki/Contributing) [2] [Geocoder](https://github.com/alexreisner/geocoder#known-issues) (“known issues”) 22 | 23 | ### Explain contributions you are NOT looking for (if any). 24 | 25 | Again, defining this up front means less work for you. If someone ignores your guide and submits something you don’t want, you can simply close it and point to your policy. 26 | 27 | > Please, don't use the issue tracker for [support questions]. Check whether the #pocoo IRC channel on Freenode can help with your issue. If your problem is not strictly Werkzeug or Flask specific, #python is generally more active. Stack Overflow is also worth considering. 28 | 29 | [source: [Flask](https://github.com/pallets/flask/blob/master/CONTRIBUTING.rst)] **Need more inspiration?** [1] [cucumber-ruby](https://github.com/cucumber/cucumber-ruby/blob/master/CONTRIBUTING.md#about-to-create-a-new-github-issue) [2] [Read the Docs](http://read-the-docs.readthedocs.org/en/latest/open-source-philosophy.html#unsupported) 30 | 31 | # Ground Rules 32 | ### Set expectations for behavior (yours, and theirs). 33 | This includes not just how to communicate with others (being respectful, considerate, etc) but also technical responsibilities (importance of testing, project dependencies, etc). Mention and link to your code of conduct, if you have one. 34 | 35 | > Responsibilities 36 | > * Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Debian & Ubuntu Linux. 37 | > * Ensure that code that goes into core meets all requirements in this checklist: https://gist.github.com/audreyr/4feef90445b9680475f2 38 | > * Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback. 39 | > * Don't add any classes to the codebase unless absolutely needed. Err on the side of using functions. 40 | > * Keep feature versions as small as possible, preferably one new feature per version. 41 | > * Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/). 42 | 43 | [source: [cookiecutter](https://github.com/audreyr/cookiecutter/blob/master/CONTRIBUTING.rst)] **Need more inspiration?** [1] [Celery](https://github.com/celery/celery/blob/master/CONTRIBUTING.rst#community-code-of-conduct) [2] [geocoder](https://github.com/alexreisner/geocoder#contributing) 44 | 45 | # Your First Contribution 46 | Help people who are new to your project understand where they can be most helpful. This is also a good time to let people know if you follow a label convention for flagging beginner issues. 47 | 48 | > Unsure where to begin contributing to Atom? You can start by looking through these beginner and help-wanted issues: 49 | > Beginner issues - issues which should only require a few lines of code, and a test or two. 50 | > Help wanted issues - issues which should be a bit more involved than beginner issues. 51 | > Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have. 52 | 53 | [source: [Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#your-first-code-contribution)] **Need more inspiration?** [1] [Read the Docs](http://docs.readthedocs.org/en/latest/contribute.html#contributing-to-development) [2] [Django](https://docs.djangoproject.com/en/dev/internals/contributing/new-contributors/#first-steps) (scroll down to "Guidelines" as well) 54 | 55 | ### Bonus points: Add a link to a resource for people who have never contributed to open source before. 56 | Here are a couple of friendly tutorials you can include: http://makeapullrequest.com/ and http://www.firsttimersonly.com/ 57 | 58 | > Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). 59 | 60 | [source: [React](https://github.com/facebook/react/blob/master/CONTRIBUTING.md#pull-requests)] 61 | 62 | As a side note, it helps to use newcomer-friendly language throughout the rest of your document. Here are a couple of examples from [Active Admin](https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md): 63 | 64 | >At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first :smile_cat: 65 | > 66 | >If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge. 67 | 68 | # Getting started 69 | ### Give them a quick walkthrough of how to submit a contribution. 70 | How you write this is up to you, but some things you may want to include: 71 | 72 | * Let them know if they need to sign a CLA, agree to a DCO, or get any other legal stuff out of the way 73 | * If tests are required for contributions, let them know, and explain how to run the tests 74 | * If you use anything other than GitHub to manage issues (ex. JIRA or Trac), let them know which tools they’ll need to contribute 75 | 76 | >For something that is bigger than a one or two line fix: 77 | 78 | >1. Create your own fork of the code 79 | >2. Do the changes in your fork 80 | >3. If you like the change and think the project could use it: 81 | * Be sure you have followed the code style for the project. 82 | * Sign the Contributor License Agreement, CLA, with the jQuery Foundation. 83 | * Note the jQuery Foundation Code of Conduct. 84 | * Send a pull request indicating that you have a CLA on file. 85 | 86 | [source: [Requirejs](http://requirejs.org/docs/contributing.html)] **Need more inspiration?** [1] [Active Admin](https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md#1-where-do-i-go-from-here) [2] [Node.js](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#code-contributions) [3] [Ember.js](https://github.com/emberjs/ember.js/blob/master/CONTRIBUTING.md#pull-requests) 87 | 88 | ### If you have a different process for small or "obvious" fixes, let them know. 89 | 90 | > Small contributions such as fixing spelling errors, where the content is small enough to not be considered intellectual property, can be submitted by a contributor as a patch, without a CLA. 91 | > 92 | >As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality or creative thinking. As long as the change does not affect functionality, some likely examples include the following: 93 | >* Spelling / grammar fixes 94 | >* Typo correction, white space and formatting changes 95 | >* Comment clean up 96 | >* Bug fixes that change default return values or error codes stored in constants 97 | >* Adding logging messages or debugging output 98 | >* Changes to ‘metadata’ files like Gemfile, .gitignore, build scripts, etc. 99 | >* Moving source files from one directory or package to another 100 | 101 | [source: [Chef](https://github.com/chef/chef/blob/master/CONTRIBUTING.md#chef-obvious-fix-policy)] **Need more inspiration?** [1] [Puppet](https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md#making-trivial-changes) 102 | 103 | # How to report a bug 104 | ### Explain security disclosures first! 105 | At bare minimum, include this sentence: 106 | > If you find a security vulnerability, do NOT open an issue. Email XXXX instead. 107 | 108 | If you don’t want to use your personal contact information, set up a “security@” email address. Larger projects might have more formal processes for disclosing security, including encrypted communication. (Disclosure: I am not a security expert.) 109 | 110 | > Any security issues should be submitted directly to security@travis-ci.org 111 | > In order to determine whether you are dealing with a security issue, ask yourself these two questions: 112 | > * Can I access something that's not mine, or something I shouldn't have access to? 113 | > * Can I disable something for other people? 114 | > 115 | > If the answer to either of those two questions are "yes", then you're probably dealing with a security issue. Note that even if you answer "no" to both questions, you may still be dealing with a security issue, so if you're unsure, just email us at security@travis-ci.org. 116 | 117 | [source: [Travis CI](https://github.com/travis-ci/travis-ci/blob/master/CONTRIBUTING.md)] **Need more inspiration?** [1] [Celery](https://github.com/celery/celery/blob/master/CONTRIBUTING.rst#security) [2] [Express.js](https://github.com/expressjs/express/blob/master/Security.md) 118 | 119 | ### Tell your contributors how to file a bug report. 120 | You can even include a template so people can just copy-paste (again, less work for you). 121 | 122 | > When filing an issue, make sure to answer these five questions: 123 | > 124 | > 1. What version of Go are you using (go version)? 125 | > 2. What operating system and processor architecture are you using? 126 | > 3. What did you do? 127 | > 4. What did you expect to see? 128 | > 5. What did you see instead? 129 | > General questions should go to the golang-nuts mailing list instead of the issue tracker. The gophers there will answer or ask you to file an issue if you've tripped over a bug. 130 | 131 | [source: [Go](https://github.com/golang/go/blob/master/CONTRIBUTING.md#filing-issues)] **Need more inspiration?** [1] [Celery](https://github.com/celery/celery/blob/master/CONTRIBUTING.rst#other-bugs ) [2] [Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#reporting-bugs) (includes template) 132 | 133 | # How to suggest a feature or enhancement 134 | ### If you have a particular roadmap, goals, or philosophy for development, share it here. 135 | This information will give contributors context before they make suggestions that may not align with the project’s needs. 136 | 137 | > The Express philosophy is to provide small, robust tooling for HTTP servers, making it a great solution for single page applications, web sites, hybrids, or public HTTP APIs. 138 | > 139 | > Express does not force you to use any specific ORM or template engine. With support for over 14 template engines via Consolidate.js, you can quickly craft your perfect framework. 140 | 141 | [source: [Express](https://github.com/expressjs/express#philosophy)] **Need more inspiration?** [Active Admin](https://github.com/activeadmin/activeadmin#goals) 142 | 143 | ### Explain your desired process for suggesting a feature. 144 | If there is back-and-forth or signoff required, say so. Ask them to scope the feature, thinking through why it’s needed and how it might work. 145 | 146 | > If you find yourself wishing for a feature that doesn't exist in Elasticsearch, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that Elasticsearch has today have been added because our users saw the need. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work. 147 | 148 | [source: [Elasticsearch](https://github.com/elastic/elasticsearch/blob/master/CONTRIBUTING.md#feature-requests)] **Need more inspiration?** [1] [Hoodie](https://github.com/hoodiehq/hoodie/blob/master/CONTRIBUTING.md#feature-requests) [2] [Ember.js](https://github.com/emberjs/ember.js/blob/master/CONTRIBUTING.md#requesting-a-feature) 149 | 150 | # Code review process 151 | ### Explain how a contribution gets accepted after it’s been submitted. 152 | Who reviews it? Who needs to sign off before it’s accepted? When should a contributor expect to hear from you? How can contributors get commit access, if at all? 153 | 154 | > The core team looks at Pull Requests on a regular basis in a weekly triage meeting that we hold in a public Google Hangout. The hangout is announced in the weekly status updates that are sent to the puppet-dev list. Notes are posted to the Puppet Community community-triage repo and include a link to a YouTube recording of the hangout. 155 | > After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity. 156 | 157 | [source: [Puppet](https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md#submitting-changes)] **Need more inspiration?** [1] [Meteor](https://meteor.hackpad.com/Responding-to-GitHub-Issues-SKE2u3tkSiH ) [2] [Express.js](https://github.com/expressjs/express/blob/master/Contributing.md#becoming-a-committer) 158 | 159 | # Community 160 | If there are other channels you use besides GitHub to discuss contributions, mention them here. You can also list the author, maintainers, and/or contributors here, or set expectations for response time. 161 | 162 | > You can chat with the core team on https://gitter.im/cucumber/cucumber. We try to have office hours on Fridays. 163 | 164 | [source: [cucumber-ruby](https://github.com/cucumber/cucumber-ruby/blob/master/CONTRIBUTING.md#talking-with-other-devs)] **Need more inspiration?** 165 | [1] [Chef](https://github.com/chef/chef/blob/master/CONTRIBUTING.md#-developer-office-hours) [2] [Cookiecutter](https://github.com/audreyr/cookiecutter#community) 166 | 167 | # BONUS: Code, commit message and labeling conventions 168 | These sections are not necessary, but can help streamline the contributions you receive. 169 | 170 | ### Explain your preferred style for code, if you have any. 171 | 172 | **Need inspiration?** [1] [Requirejs](http://requirejs.org/docs/contributing.html#codestyle) [2] [Elasticsearch](https://github.com/elastic/elasticsearch/blob/master/CONTRIBUTING.md#contributing-to-the-elasticsearch-codebase) 173 | 174 | ### Explain if you use any commit message conventions. 175 | 176 | **Need inspiration?** [1] [Angular](https://github.com/angular/material/blob/master/.github/CONTRIBUTING.md#submit) [2] [Node.js](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-3-commit) 177 | 178 | ### Explain if you use any labeling conventions for issues. 179 | 180 | **Need inspiration?** [1] [StandardIssueLabels](https://github.com/wagenet/StandardIssueLabels#standardissuelabels) [2] [Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#issue-and-pull-request-labels) 181 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | CC0 1.0 Universal 2 | 3 | Statement of Purpose 4 | 5 | The laws of most jurisdictions throughout the world automatically confer 6 | exclusive Copyright and Related Rights (defined below) upon the creator and 7 | subsequent owner(s) (each and all, an "owner") of an original work of 8 | authorship and/or a database (each, a "Work"). 9 | 10 | Certain owners wish to permanently relinquish those rights to a Work for the 11 | purpose of contributing to a commons of creative, cultural and scientific 12 | works ("Commons") that the public can reliably and without fear of later 13 | claims of infringement build upon, modify, incorporate in other works, reuse 14 | and redistribute as freely as possible in any form whatsoever and for any 15 | purposes, including without limitation commercial purposes. These owners may 16 | contribute to the Commons to promote the ideal of a free culture and the 17 | further production of creative, cultural and scientific works, or to gain 18 | reputation or greater distribution for their Work in part through the use and 19 | efforts of others. 20 | 21 | For these and/or other purposes and motivations, and without any expectation 22 | of additional consideration or compensation, the person associating CC0 with a 23 | Work (the "Affirmer"), to the extent that he or she is an owner of Copyright 24 | and Related Rights in the Work, voluntarily elects to apply CC0 to the Work 25 | and publicly distribute the Work under its terms, with knowledge of his or her 26 | Copyright and Related Rights in the Work and the meaning and intended legal 27 | effect of CC0 on those rights. 28 | 29 | 1. Copyright and Related Rights. A Work made available under CC0 may be 30 | protected by copyright and related or neighboring rights ("Copyright and 31 | Related Rights"). Copyright and Related Rights include, but are not limited 32 | to, the following: 33 | 34 | i. the right to reproduce, adapt, distribute, perform, display, communicate, 35 | and translate a Work; 36 | 37 | ii. moral rights retained by the original author(s) and/or performer(s); 38 | 39 | iii. publicity and privacy rights pertaining to a person's image or likeness 40 | depicted in a Work; 41 | 42 | iv. rights protecting against unfair competition in regards to a Work, 43 | subject to the limitations in paragraph 4(a), below; 44 | 45 | v. rights protecting the extraction, dissemination, use and reuse of data in 46 | a Work; 47 | 48 | vi. database rights (such as those arising under Directive 96/9/EC of the 49 | European Parliament and of the Council of 11 March 1996 on the legal 50 | protection of databases, and under any national implementation thereof, 51 | including any amended or successor version of such directive); and 52 | 53 | vii. other similar, equivalent or corresponding rights throughout the world 54 | based on applicable law or treaty, and any national implementations thereof. 55 | 56 | 2. Waiver. To the greatest extent permitted by, but not in contravention of, 57 | applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and 58 | unconditionally waives, abandons, and surrenders all of Affirmer's Copyright 59 | and Related Rights and associated claims and causes of action, whether now 60 | known or unknown (including existing as well as future claims and causes of 61 | action), in the Work (i) in all territories worldwide, (ii) for the maximum 62 | duration provided by applicable law or treaty (including future time 63 | extensions), (iii) in any current or future medium and for any number of 64 | copies, and (iv) for any purpose whatsoever, including without limitation 65 | commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes 66 | the Waiver for the benefit of each member of the public at large and to the 67 | detriment of Affirmer's heirs and successors, fully intending that such Waiver 68 | shall not be subject to revocation, rescission, cancellation, termination, or 69 | any other legal or equitable action to disrupt the quiet enjoyment of the Work 70 | by the public as contemplated by Affirmer's express Statement of Purpose. 71 | 72 | 3. Public License Fallback. Should any part of the Waiver for any reason be 73 | judged legally invalid or ineffective under applicable law, then the Waiver 74 | shall be preserved to the maximum extent permitted taking into account 75 | Affirmer's express Statement of Purpose. In addition, to the extent the Waiver 76 | is so judged Affirmer hereby grants to each affected person a royalty-free, 77 | non transferable, non sublicensable, non exclusive, irrevocable and 78 | unconditional license to exercise Affirmer's Copyright and Related Rights in 79 | the Work (i) in all territories worldwide, (ii) for the maximum duration 80 | provided by applicable law or treaty (including future time extensions), (iii) 81 | in any current or future medium and for any number of copies, and (iv) for any 82 | purpose whatsoever, including without limitation commercial, advertising or 83 | promotional purposes (the "License"). The License shall be deemed effective as 84 | of the date CC0 was applied by Affirmer to the Work. Should any part of the 85 | License for any reason be judged legally invalid or ineffective under 86 | applicable law, such partial invalidity or ineffectiveness shall not 87 | invalidate the remainder of the License, and in such case Affirmer hereby 88 | affirms that he or she will not (i) exercise any of his or her remaining 89 | Copyright and Related Rights in the Work or (ii) assert any associated claims 90 | and causes of action with respect to the Work, in either case contrary to 91 | Affirmer's express Statement of Purpose. 92 | 93 | 4. Limitations and Disclaimers. 94 | 95 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 96 | surrendered, licensed or otherwise affected by this document. 97 | 98 | b. Affirmer offers the Work as-is and makes no representations or warranties 99 | of any kind concerning the Work, express, implied, statutory or otherwise, 100 | including without limitation warranties of title, merchantability, fitness 101 | for a particular purpose, non infringement, or the absence of latent or 102 | other defects, accuracy, or the present or absence of errors, whether or not 103 | discoverable, all to the greatest extent permissible under applicable law. 104 | 105 | c. Affirmer disclaims responsibility for clearing rights of other persons 106 | that may apply to the Work or any use thereof, including without limitation 107 | any person's Copyright and Related Rights in the Work. Further, Affirmer 108 | disclaims responsibility for obtaining any necessary consents, permissions 109 | or other rights required for any use of the Work. 110 | 111 | d. Affirmer understands and acknowledges that Creative Commons is not a 112 | party to this document and has no duty or obligation with respect to this 113 | CC0 or use of the Work. 114 | 115 | For more information, please see 116 | 117 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Contributing Guides: A Template 2 | 3 | A template for writing your own contributing guide. Contributing guides are helpful documents that communicate how people can contribute to your open source project. 4 | 5 | This template is meant to be a checklist to make sure you haven’t missed anything, rather than offering guidance on philosophy or approach. Your final guidelines may differ depending on your project and needs. 6 | 7 | I made this template to share what I learned after reviewing 40 open source projects of all sizes and their contributing guides (or lack thereof). Thanks to all the examples used in this template: 8 | 9 | [Active Admin](https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md), [Read The Docs](http://read-the-docs.readthedocs.org/en/latest/contribute.html), [Mustache.js](https://github.com/janl/mustache.js/#contributing), [Hoodie](https://github.com/hoodiehq/hoodie/blob/master/CONTRIBUTING.md), [Elasticsearch](https://github.com/elastic/elasticsearch/blob/master/CONTRIBUTING.md), [Devise](https://github.com/plataformatec/devise/blob/master/CONTRIBUTING.md), [Geocoder](https://github.com/alexreisner/geocoder#contributing), [Flask](https://github.com/pallets/flask/blob/master/CONTRIBUTING.rst), [Cucumber-ruby](https://github.com/cucumber/cucumber-ruby/blob/master/CONTRIBUTING.md), [Cookiecutter](https://github.com/audreyr/cookiecutter/blob/master/CONTRIBUTING.rst), [Celery](https://github.com/celery/celery/blob/master/CONTRIBUTING.rst), [Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md), [Django](https://github.com/django/django/blob/master/CONTRIBUTING.rst), [React](https://github.com/facebook/react/blob/master/CONTRIBUTING.md), [Require.js](https://requirejs.org/docs/contributing.html), [Node.js](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md), [Ember.js](https://github.com/emberjs/ember.js/blob/master/CONTRIBUTING.md), [Chef](https://github.com/chef/chef/blob/master/CONTRIBUTING.md), [Puppet](https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md), [Travis CI](https://github.com/travis-ci/travis-ci/blob/master/CONTRIBUTING.md), [Express](https://github.com/expressjs/express/blob/master/Contributing.md), [Meteor](https://github.com/meteor/meteor/blob/devel/CONTRIBUTING.md), [Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md), [StandardIssueLabels](https://github.com/wagenet/StandardIssueLabels#standardissuelabels) 10 | 11 | Special thanks also to @mikeal and his post ["Healthy Open Source"](https://medium.com/the-javascript-collection/healthy-open-source-967fa8be7951) about Node.js's contribution policies for inspiring this project. 12 | 13 | # How to get started 14 | To use this template, create CONTRIBUTING.md in the top level of your project, copy the template, and fill it out with your information. 15 | 16 | When you’re done, make sure people see your shiny new contributing guide: 17 | * **Link back to your contributing guide in your Readme.** Create a section called “Contributing” and link to CONTRIBUTING.md: *“Thanks for your interest in contributing! There are many ways to contribute to this project. Get started here (link).”* 18 | * **If you have a website for your project,** add a section called “Contributing” and link to your contributing guide. Or copy-paste your guide into the website and link to them in your CONTRIBUTING.md file. 19 | 20 | Finally, a couple of tips to help you write: 21 | * **A friendly, welcoming voice will go a long way in making people feel excited to contribute to your project.** Don’t forget to explain terms or concepts that might be confusing to a newcomer. 22 | * **Use this as an opportunity to lay the ground rules that will make you happy.** The purpose of writing a guide is to make your life easier. It’s okay to say “XYZ pull requests are not accepted” or “I am busy, expect 1-2 weeks to review and merge your PR”. Clarifying your needs up front will make it much faster to review future contributions. 23 | * **Be concise.** Adding too much detail might actually make people less likely to read your guide, which will defeat the purpose. 24 | 25 | That’s it! 26 | 27 | # Contributing to this template 28 | This template reflects what I learned from reviewing the policies of many open source projects, not my experience as an open source maintainer. If you think something important is missing or should be different based on your experience, I'd love to hear it! (Keep in mind this is meant to be a first pass checklist, not a full-fledged guide in itself.) If you have suggestions for improving this template, open an issue on this project. 29 | 30 | # Translations 31 | [Spanish(español)](https://github.com/valerybriz/contributing-template/blob/master/CONTRIBUTING-template.md) 32 | 33 | # License & Attribution 34 | This template is available under the [Creative Commons CC0 1.0 License](https://creativecommons.org/publicdomain/zero/1.0/), meaning you are free to use it for any purpose, commercial or non-commercial, without any attribution back to me (public domain). If you use it in your project, I'd love to hear about it! (Find me here: [@nayafia](https://twitter.com/nayafia)) But you are in no way required to do so. 35 | --------------------------------------------------------------------------------