New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING.md #1260

Closed
wants to merge 2 commits into
base: master
from

Conversation

Projects
None yet
3 participants
@fabacino
Contributor

fabacino commented Oct 30, 2017

Hopefully, this leads to more bug reports with a description to reproduce the error. Feel free to adjust the text to your liking.

Relates to #1123

Before reporting a bug, please take a look at the [FAQ](https://github.com/abo-abo/swiper/blob/master/README.md), as well as the [manual](http://oremacs.com/swiper/) and the [wiki](https://github.com/abo-abo/swiper/wiki). Please also make sure that there is not yet an existing issue.
In order to fix it, we need to be able to reproduce the bug you encountered as closely as possible, so please describe the problem as detailed as you can. It is important that we can rule out interference with other emacs packages or customisations, therefore use `emacs -Q` to bypass your init file or use the shell code below to sandbox your emacs environment even further.

This comment has been minimized.

@basil-conto

basil-conto Oct 30, 2017

Contributor

Couple of nitpicks:

  • "describe the problem in as much detail as possible" instead of "describe the problem as detailed as you can"
  • "Emacs packages" instead of "emacs packages"
$ HOME="$PWD" emacs -L .
```
You can use `eval-expression` to load swiper/ivy and counsel and continue from there.

This comment has been minimized.

@basil-conto

basil-conto Oct 30, 2017

Contributor

Perhaps it's worth mentioning the make plain target, which already does this?

This comment has been minimized.

@fabacino

fabacino Oct 30, 2017

Contributor

Thanks, forgot about that.

The basic code style guide is to use `(setq indent-tabs-mode nil)`. It is provided for you in [.dir-locals.el](https://github.com/abo-abo/swiper/blob/master/.dir-locals.el), please obey it.
Before submitting the change, run `make compile` and `make test` to make sure that it doesn't introduce new compile warnings or test failures. Also run `make checkdoc` to see that your changes obey the documentation guidelines.

This comment has been minimized.

@basil-conto

basil-conto Oct 30, 2017

Contributor

More nitpick suggestions:

  • "a change" instead of "the change"
  • "compilation warnings" instead of "compile warnings"
  • "or cause tests to fail, respectively" instead of "or test failures"
  • "obey documentation guidelines" or "obey Emacs documentation guidelines" instead of "obey the documentation guidelines"
# Copyright Assignment
These package are subject to the same [copyright assignment](http://www.gnu.org/prep/maintain/html_node/Copyright-Papers.html) policy as Emacs itself, org-mode, CEDET and other packages in [GNU ELPA](http://elpa.gnu.org/packages/). Any [legally significant](http://www.gnu.org/prep/maintain/html_node/Legally-Significant.html#Legally-Significant) contributions can only be accepted after the author has completed their paperwork. Please see [the request form](http://git.savannah.gnu.org/cgit/gnulib.git/tree/doc/Copyright/request-assign.future) if you want to proceed.

This comment has been minimized.

@basil-conto

basil-conto Oct 30, 2017

Contributor

Typo: "These packages" instead of "These package"
Nitpick: "if you want to proceed with the assignment" instead of "if you want to proceed"

@fabacino

This comment has been minimized.

Contributor

fabacino commented Oct 30, 2017

@basil-conto Thanks for your feedback. I've made the changes you suggested.

@abo-abo abo-abo closed this in 26b22ab Oct 30, 2017

abo-abo added a commit that referenced this pull request Oct 30, 2017

@abo-abo

This comment has been minimized.

Owner

abo-abo commented Oct 30, 2017

Thanks. With orca, I'm using README.org and I see that Github's handling of org-mode has improved. So I renamed CONTRIBUTING.md to CONTRIBUTING.org.

For the reproduction, I'd like to keep the description and steps as simple as possible. So I suggest relying on make plain; I also added counsel-mode there.

@fabacino fabacino deleted the fabacino:feature/contributing branch Oct 31, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment