From dc1ab5b9ea36db0f7ecebda5790ee9f2e13522db Mon Sep 17 00:00:00 2001 From: Matt Baer Date: Sat, 18 Nov 2017 21:51:29 -0500 Subject: [PATCH] Move Contributing guidelines to .github dir --- .github/CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 37 ------------------------------------- README.md | 2 +- 3 files changed, 38 insertions(+), 38 deletions(-) create mode 100644 .github/CONTRIBUTING.md delete mode 100644 CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..8c14a19 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# How to contribute + +We're happy you're considering contributing to the Write.as command-line client! + +It won't take long to get up to speed on this. Here are our development resources: + +* We do our project management in [Phabricator](https://phabricator.write.as/tag/write.as_cli/). +* We accept and respond to bugs here on [GitHub](https://github.com/writeas/writeas-cli/issues). +* We're usually in #writeas on freenode, but if not, find us on our [Slack channel](http://slack.write.as). + +## Testing + +We try to write tests for all parts of the CLI, but aren't there yet. While not required, including tests with your new code will bring us closer to where we want to be and speed up our review. + +## Submitting changes + +Please send a [pull request](https://github.com/writeas/writeas-cli/compare) with a clear list of what you've done. + +Please follow our coding conventions below and make sure all of your commits are atomic. Larger changes should have commits with more detailed information on what changed, any impact on existing code, rationales, etc. + +## Coding conventions + +We strive for consistency above all. Reading the small codebase should give you a good idea of the conventions we follow. + +* We use `go fmt` before committing anything +* We aim to document all exported entities +* Go files are broken up into logical functional components +* General functions are extracted into modules when possible + +## Design conventions + +We maintain a few high-level design principles in all decisions we make. Keep these in mind while devising new functionality: + +* Updates should be backwards compatible or provide a seamless migration path from *any* previous version +* Each subcommand should perform one action and do it well +* Each subcommand will ideally work well in a script +* Avoid clever functionality and assume each function will be used in ways we didn't imagine diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 8c14a19..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,37 +0,0 @@ -# How to contribute - -We're happy you're considering contributing to the Write.as command-line client! - -It won't take long to get up to speed on this. Here are our development resources: - -* We do our project management in [Phabricator](https://phabricator.write.as/tag/write.as_cli/). -* We accept and respond to bugs here on [GitHub](https://github.com/writeas/writeas-cli/issues). -* We're usually in #writeas on freenode, but if not, find us on our [Slack channel](http://slack.write.as). - -## Testing - -We try to write tests for all parts of the CLI, but aren't there yet. While not required, including tests with your new code will bring us closer to where we want to be and speed up our review. - -## Submitting changes - -Please send a [pull request](https://github.com/writeas/writeas-cli/compare) with a clear list of what you've done. - -Please follow our coding conventions below and make sure all of your commits are atomic. Larger changes should have commits with more detailed information on what changed, any impact on existing code, rationales, etc. - -## Coding conventions - -We strive for consistency above all. Reading the small codebase should give you a good idea of the conventions we follow. - -* We use `go fmt` before committing anything -* We aim to document all exported entities -* Go files are broken up into logical functional components -* General functions are extracted into modules when possible - -## Design conventions - -We maintain a few high-level design principles in all decisions we make. Keep these in mind while devising new functionality: - -* Updates should be backwards compatible or provide a seamless migration path from *any* previous version -* Each subcommand should perform one action and do it well -* Each subcommand will ideally work well in a script -* Avoid clever functionality and assume each function will be used in ways we didn't imagine diff --git a/README.md b/README.md index 542d004..5285667 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ GLOBAL OPTIONS: ## Contributing to the CLI -For a complete guide to contributing, see the [Contribution Guide](CONTRIBUTING.md). +For a complete guide to contributing, see the [Contribution Guide](.github/CONTRIBUTING.md). We welcome any kind of contributions including documentation, organizational improvements, tutorials, bug reports, feature requests, new features, answering questions, etc.