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

85 lines
3.3 KiB
ReStructuredText
Raw Normal View History

Adopt a Code of Conduct Include the text of the Contributor Covenant (1.1.0) in CONTRIBUTING.rst, and add a link to the document to README.md. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
2015-06-23 14:28:56 +02:00
Contributor Guidelines
======================
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.
Adopt a Code of Conduct Include the text of the Contributor Covenant (1.1.0) in CONTRIBUTING.rst, and add a link to the document to README.md. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
2015-06-23 14:28:56 +02:00
Contributor Code of Conduct
===========================
As contributors and maintainers of this project, we pledge to respect
all people who contribute through reporting issues, posting feature
requests, updating documentation, submitting pull requests or patches,
and other activities.
We are committed to making participation in this project a
harassment-free experience for everyone, regardless of level of
experience, gender, gender identity and expression, sexual
orientation, disability, personal appearance, body size, race,
ethnicity, age, or religion.
Examples of unacceptable behavior by participants include the use of
sexual language or imagery, derogatory comments or personal attacks,
trolling, public or private harassment, insults, or other
unprofessional conduct.
Project maintainers have the right and responsibility to remove, edit,
or reject comments, commits, code, wiki edits, issues, and other
contributions that are not aligned to this Code of Conduct. Project
maintainers who do not follow the Code of Conduct may be removed from
the project team.
This code of conduct applies both within project spaces and in public
spaces when an individual is representing the project or its
community.
Instances of abusive, harassing, or otherwise unacceptable behavior
may be reported by opening an issue or contacting one or more of the
project maintainers.
This Code of Conduct is adapted from the `Contributor Covenant`_,
version 1.1.0, available at
http://contributor-covenant.org/version/1/1/0/.
.. _Contributor Covenant: http://contributor-covenant.org
Copy Permalink