Yaltik
/
hy
2
0
Fork 0
Code Pull Requests Releases Activity
hy/CONTRIBUTING.rst

43 lines
1.7 KiB
ReStructuredText
Raw Normal View History

Move contributing from hacking docs to repo root A CONTRIBUTING.rst is added to the root of the repo, as Github automatically recognizes this for incoming PRs (ref: https://github.com/blog/1184-contributing-guidelines) Most of the information is directly borrowed from the existing hacking docs, which is restructured to refer to this file instead for contribution guidelines
2014-05-02 20:27:04 +02:00
Contributions are welcome & greatly appreciated, every little bit
helps in making Hy more awesome.
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes.
2014-12-06 08:13:40 +01:00
Pull requests are great! We love them; here is a quick guide:
Move contributing from hacking docs to repo root A CONTRIBUTING.rst is added to the root of the repo, as Github automatically recognizes this for incoming PRs (ref: https://github.com/blog/1184-contributing-guidelines) Most of the information is directly borrowed from the existing hacking docs, which is restructured to refer to this file instead for contribution guidelines
2014-05-02 20:27:04 +02:00
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes.
2014-12-06 08:13:40 +01:00
- Fork the repo and create a topic branch for a feature/fix. Avoid
making changes directly on the master branch.
Move contributing from hacking docs to repo root A CONTRIBUTING.rst is added to the root of the repo, as Github automatically recognizes this for incoming PRs (ref: https://github.com/blog/1184-contributing-guidelines) Most of the information is directly borrowed from the existing hacking docs, which is restructured to refer to this file instead for contribution guidelines
2014-05-02 20:27:04 +02:00
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes.
2014-12-06 08:13:40 +01:00
- All incoming features should be accompanied with tests.
Move contributing from hacking docs to repo root A CONTRIBUTING.rst is added to the root of the repo, as Github automatically recognizes this for incoming PRs (ref: https://github.com/blog/1184-contributing-guidelines) Most of the information is directly borrowed from the existing hacking docs, which is restructured to refer to this file instead for contribution guidelines
2014-05-02 20:27:04 +02:00
- Before you submit a PR, please run the tests and check your code
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes.
2014-12-06 08:13:40 +01:00
against the style guide. You can do both of these things at once::
Move contributing from hacking docs to repo root A CONTRIBUTING.rst is added to the root of the repo, as Github automatically recognizes this for incoming PRs (ref: https://github.com/blog/1184-contributing-guidelines) Most of the information is directly borrowed from the existing hacking docs, which is restructured to refer to this file instead for contribution guidelines
2014-05-02 20:27:04 +02:00
$ make d
- Make commits into logical units, so that it is easier to track &
navigate later. Before submitting a PR, try squashing the commits
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes.
2014-12-06 08:13:40 +01:00
into changesets that are easy to come back to later. Also, make sure
you don't leave spurious whitespace in the changesets; this avoids
Move contributing from hacking docs to repo root A CONTRIBUTING.rst is added to the root of the repo, as Github automatically recognizes this for incoming PRs (ref: https://github.com/blog/1184-contributing-guidelines) Most of the information is directly borrowed from the existing hacking docs, which is restructured to refer to this file instead for contribution guidelines
2014-05-02 20:27:04 +02:00
creation of whitespace fix commits later.
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes.
2014-12-06 08:13:40 +01:00
- As far as commit messages go, try to adhere to the following:
Move contributing from hacking docs to repo root A CONTRIBUTING.rst is added to the root of the repo, as Github automatically recognizes this for incoming PRs (ref: https://github.com/blog/1184-contributing-guidelines) Most of the information is directly borrowed from the existing hacking docs, which is restructured to refer to this file instead for contribution guidelines
2014-05-02 20:27:04 +02:00
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes.
2014-12-06 08:13:40 +01:00
+ Try sticking to the 50 character limit for the first line of Git
commit messages.
Move contributing from hacking docs to repo root A CONTRIBUTING.rst is added to the root of the repo, as Github automatically recognizes this for incoming PRs (ref: https://github.com/blog/1184-contributing-guidelines) Most of the information is directly borrowed from the existing hacking docs, which is restructured to refer to this file instead for contribution guidelines
2014-05-02 20:27:04 +02:00
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes.
2014-12-06 08:13:40 +01:00
+ For more detail/explainations, follow this up with a blank line and
continue describing the commit in detail.
Move contributing from hacking docs to repo root A CONTRIBUTING.rst is added to the root of the repo, as Github automatically recognizes this for incoming PRs (ref: https://github.com/blog/1184-contributing-guidelines) Most of the information is directly borrowed from the existing hacking docs, which is restructured to refer to this file instead for contribution guidelines
2014-05-02 20:27:04 +02:00
Various changes to documentation pages - Standardized capitalization of Hy, Lisp(s), and Python. - Added periods to the end of list items. - Use inline code blocks for inline code. - Stripped trailing whitespace. - Other miscellaneous grammatical changes.
2014-12-06 08:13:40 +01:00
- Finally, add yourself to the AUTHORS file (as a separate commit): you
Move contributing from hacking docs to repo root A CONTRIBUTING.rst is added to the root of the repo, as Github automatically recognizes this for incoming PRs (ref: https://github.com/blog/1184-contributing-guidelines) Most of the information is directly borrowed from the existing hacking docs, which is restructured to refer to this file instead for contribution guidelines
2014-05-02 20:27:04 +02:00
deserve it :)
- All incoming changes need to be acked by 2 different members of
Hylang's core team. Additional review is clearly welcome, but we need
a minimum of 2 signoffs for any change.
- If a core member is sending in a PR, please find 2 core members that doesn't
include the PR submitter. The idea here is that one can work with the PR
author, and a second acks the entire change set.
- For documentation & other trivial changes, we're good to merge after one
ACK. We've got low coverage, so it'd be great to keep that barrier low.