Minor fixes and improvements to CONTRIBUTING.md
Fixing a few typos, improving the formatting and other improvements.
This commit is contained in:
parent
dcf926377f
commit
75c0ece416
|
@ -2,10 +2,9 @@
|
||||||
|
|
||||||
Want to show Sinatra some love? Help out by contributing!
|
Want to show Sinatra some love? Help out by contributing!
|
||||||
|
|
||||||
## Find a bug?
|
## Found a bug?
|
||||||
|
|
||||||
Log it in our [issue tracker][ghi] or send a
|
Log it in our [issue tracker][ghi] or send a note to the [mailing list][ml].
|
||||||
note to the [mailing list][ml].
|
|
||||||
Be sure to include all relevant information, like the versions of Sinatra and
|
Be sure to include all relevant information, like the versions of Sinatra and
|
||||||
Ruby you're using. A [gist](http://gist.github.com/) of the code that caused
|
Ruby you're using. A [gist](http://gist.github.com/) of the code that caused
|
||||||
the issue as well as any error messages are also very helpful.
|
the issue as well as any error messages are also very helpful.
|
||||||
|
@ -13,8 +12,8 @@ the issue as well as any error messages are also very helpful.
|
||||||
## Need help?
|
## Need help?
|
||||||
|
|
||||||
The [Sinatra mailing list][ml] has over 900 subscribers, many of which are happy
|
The [Sinatra mailing list][ml] has over 900 subscribers, many of which are happy
|
||||||
to help out newbies or talk about potential feature additions. You can also drop by
|
to help out newbies or talk about potential feature additions. You can also
|
||||||
the [#sinatra](irc://chat.freenode.net/#sinatra) channel on
|
drop by the [#sinatra](irc://chat.freenode.net/#sinatra) channel on
|
||||||
[irc.freenode.net](http://freenode.net).
|
[irc.freenode.net](http://freenode.net).
|
||||||
|
|
||||||
## Have a patch?
|
## Have a patch?
|
||||||
|
@ -37,9 +36,9 @@ can be applied as quickly as possible:
|
||||||
modify the `README.md` file to reflect that. Again, if you don't
|
modify the `README.md` file to reflect that. Again, if you don't
|
||||||
update the `README`, we have to, and this holds up acceptance.
|
update the `README`, we have to, and this holds up acceptance.
|
||||||
|
|
||||||
4. **Update the Changelog (`CHANGES`):** The changelog helps give an
|
4. **Update the changelog (`CHANGES`):** The changelog helps give an
|
||||||
overview of the changes that go into each release, and gives credit
|
overview of the changes that go into each release, and gives credit
|
||||||
where credit is due. We make sure that the Changelog is up to date
|
where credit is due. We make sure that the changelog is up to date
|
||||||
before each release, and we always appreciate it when people make
|
before each release, and we always appreciate it when people make
|
||||||
it easier to get the release out the door.
|
it easier to get the release out the door.
|
||||||
|
|
||||||
|
@ -48,53 +47,54 @@ can be applied as quickly as possible:
|
||||||
something like, "you can find the patch on johndoe/foobranch". We also
|
something like, "you can find the patch on johndoe/foobranch". We also
|
||||||
gladly accept GitHub [pull requests](http://help.github.com/pull-requests/).
|
gladly accept GitHub [pull requests](http://help.github.com/pull-requests/).
|
||||||
|
|
||||||
__NOTE:__ _we will take whatever we can get._ If you prefer to
|
__NOTE:__ _We will take whatever we can get._ If you prefer to attach diffs in
|
||||||
attach diffs in emails to the mailing list, that's fine; but do know
|
emails to the mailing list, that's fine; but do know that _someone_ will need
|
||||||
that _someone_ will need to take the diff through the process described
|
to take the diff through the process described above and this can hold things
|
||||||
above and this can hold things up considerably.
|
up considerably.
|
||||||
|
|
||||||
## Want to write docs?
|
## Want to write docs?
|
||||||
|
|
||||||
The process for contributing to Sinatra's website, documentation or the book
|
The process for contributing to Sinatra's website, documentation or the book
|
||||||
is the same as contributing code. We use git for versions control and
|
is the same as contributing code. We use Git for versions control and GitHub to
|
||||||
GitHub to track patch requests.
|
track patch requests.
|
||||||
|
|
||||||
* [The sinatra.github.com repo](http://github.com/sinatra/sinatra.github.com/)
|
* [The sinatra.github.com repo](http://github.com/sinatra/sinatra.github.com/)
|
||||||
is where the website sources are managed. There are almost always people in
|
is where the website sources are managed. There are almost always people in
|
||||||
`#sinatra` that are happy to discuss, apply, and publish website patches.
|
`#sinatra` that are happy to discuss, apply, and publish website patches.
|
||||||
|
|
||||||
* [The Book](http://sinatra-book.gittr.com/) has its own [git
|
* [The Book](http://sinatra-book.gittr.com/) has its own [Git
|
||||||
repository](http://github.com/sinatra/sinatra-book/) and build process but is
|
repository](http://github.com/sinatra/sinatra-book/) and build process but is
|
||||||
managed the same as the website and project codebase.
|
managed the same as the website and project codebase.
|
||||||
|
|
||||||
* [Sinatra Recipes](http://recipes.sinatrarb.com/) is a community
|
* [Sinatra Recipes](http://recipes.sinatrarb.com/) is a community
|
||||||
project where anyone is free to contribute ideas, recipes and tutorials. Which
|
project where anyone is free to contribute ideas, recipes and tutorials. Which
|
||||||
also has its own [git
|
also has its own [Git repository](http://github.com/sinatra/sinatra-recipes).
|
||||||
repository](http://github.com/sinatra/sinatra-recipes).
|
|
||||||
|
|
||||||
* [The Introduction](http://www.sinatrarb.com/intro.html) is generated from
|
* [The Introduction](http://www.sinatrarb.com/intro.html) is generated from
|
||||||
Sinatra's [README file](http://github.com/sinatra/sinatra/blob/master/README.md).
|
Sinatra's [README file](http://github.com/sinatra/sinatra/blob/master/README.md).
|
||||||
|
|
||||||
* If you want to help translating the documentation, the README is already available in
|
* If you want to help translating the documentation, the README is already
|
||||||
|
available in
|
||||||
[Japanese](http://github.com/sinatra/sinatra/blob/master/README.ja.md),
|
[Japanese](http://github.com/sinatra/sinatra/blob/master/README.ja.md),
|
||||||
[German](http://github.com/sinatra/sinatra/blob/master/README.de.md),
|
[German](http://github.com/sinatra/sinatra/blob/master/README.de.md),
|
||||||
[Chinese](https://github.com/sinatra/sinatra/blob/master/README.zh.md),
|
[Chinese](https://github.com/sinatra/sinatra/blob/master/README.zh.md),
|
||||||
[Russian](https://github.com/sinatra/sinatra/blob/master/README.ru.md),
|
[Russian](https://github.com/sinatra/sinatra/blob/master/README.ru.md),
|
||||||
[European](https://github.com/sinatra/sinatra/blob/master/README.pt-pt.md) and
|
[European](https://github.com/sinatra/sinatra/blob/master/README.pt-pt.md) and
|
||||||
[Brazillian](https://github.com/sinatra/sinatra/blob/master/README.pt-br.md) Portugese,
|
[Brazilian](https://github.com/sinatra/sinatra/blob/master/README.pt-br.md)
|
||||||
|
Portuguese,
|
||||||
[French](https://github.com/sinatra/sinatra/blob/master/README.fr.md),
|
[French](https://github.com/sinatra/sinatra/blob/master/README.fr.md),
|
||||||
[Spanish](https://github.com/sinatra/sinatra/blob/master/README.es.md),
|
[Spanish](https://github.com/sinatra/sinatra/blob/master/README.es.md),
|
||||||
[Korean](https://github.com/sinatra/sinatra/blob/master/README.ko.md), and
|
[Korean](https://github.com/sinatra/sinatra/blob/master/README.ko.md), and
|
||||||
[Hungarian](https://github.com/sinatra/sinatra/blob/master/README.hu.md).
|
[Hungarian](https://github.com/sinatra/sinatra/blob/master/README.hu.md).
|
||||||
The translations tend to fall behind the English version. Translations into other
|
The translations tend to fall behind the English version. Translations into
|
||||||
languages would also be appreciated.
|
other languages would also be appreciated.
|
||||||
|
|
||||||
## Looking for something to do?
|
## Looking for something to do?
|
||||||
|
|
||||||
If you'd like to help out but aren't sure how, pick something that looks
|
If you'd like to help out but aren't sure how, pick something that looks
|
||||||
interesting from the [issues][ghi] list and hack on. Make sure to leave a
|
interesting from the [issues][ghi] list and hack on. Make sure to leave a
|
||||||
comment on the ticket noting that you're investigating (a simple "Taking..."
|
comment on the ticket noting that you're investigating (a simple "Taking…" is
|
||||||
is fine).
|
fine).
|
||||||
|
|
||||||
[ghi]: http://github.com/sinatra/sinatra/issues
|
[ghi]: http://github.com/sinatra/sinatra/issues
|
||||||
[ml]: http://groups.google.com/group/sinatrarb/topics "Sinatra Mailing List"
|
[ml]: http://groups.google.com/group/sinatrarb/topics "Sinatra Mailing List"
|
||||||
|
|
Loading…
Reference in New Issue