From fedf8c44bf5445563d0b8816794b0e7662c1fc74 Mon Sep 17 00:00:00 2001 From: Alan Bernstein Date: Fri, 11 May 2018 14:42:29 -0500 Subject: [PATCH] Minor updates to contributing guide and docs readme --- CONTRIBUTING.md | 4 +++- docs/README.md | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 925f789b8..352760c0d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,7 @@ # Contributing to Pilosa +The workflow components of these instructions apply to all of our repos. + ## Reporting a bug If you have discovered a bug and don't see it in the [github issue tracker][5], [open a new issue][1]. @@ -154,7 +156,7 @@ Additional commands are available in the `Makefile`. git checkout -b something-amazing ``` -- Commit your changes locally using `git add` and `git commit`. +- Commit your changes locally using `git add` and `git commit`. Please use [appropriate commit messages](https://chris.beams.io/posts/git-commit/). - Make sure that you've written tests for your new feature, and then run the tests: diff --git a/docs/README.md b/docs/README.md index 6a9f50b45..21fa269c0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,5 @@ Pilosa docs are maintained here, to stay in sync with the codebase. The format is [Blackfriday](https://github.com/russross/blackfriday) markdown, with some Hugo [front matter](https://gohugo.io/content-management/front-matter/). -Please visit [our website](https://www.pilosa.com/docs/) to view the docs complete with styles, diagrams, and comprehensive search. +Please visit [our website](https://www.pilosa.com/docs/) to view the docs complete with styles, diagrams, and comprehensive search. Internal links will only work on the website. Have you found a discrepancy, typo, or other problem? Please submit an [issue](https://github.com/pilosa/pilosa/issues/new) or a pull request!