Skip to content
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

Document how to get help and contribute #101

Closed
cdeil opened this issue Sep 4, 2015 · 2 comments
Closed

Document how to get help and contribute #101

cdeil opened this issue Sep 4, 2015 · 2 comments
Assignees
Milestone

Comments

@cdeil
Copy link
Member

cdeil commented Sep 4, 2015

Currently we have no information in the docs how to get help or how to contribute:
http://astroplan.readthedocs.org/en/latest/

For help, i.e. user questions how to do XY, why AB doesn't work etc. I think pointing to the Astropy mailing list for now is fine. If there's a lot of questions, we can always set up our own mailing list.
Another good option might be stackoverflow with an astropy and / or astroplan tag.
@eteq – What do you think?

Concerning how to contribute, I think having a lot of text like http://photutils.readthedocs.org/en/latest/#contributing or https://sncosmo.readthedocs.org/en/v1.1.x/contributing.html isn't needed.
So I'd suggest just saying a few sentences like "same as Astropy, use Github" and point to http://astropy.readthedocs.org/en/latest/#contributing.
But a sentence or two like "this is a very young project, we very much welcome contributions of new features like planets, scheduling, GUI, ... just talk to us" are good to have, I think.

@jberlanga or @bmorris3 – Can you try to find a good place and wording for a short section on this in the docs?

@cdeil cdeil added this to the 0.1 release milestone Sep 4, 2015
@bmorris3
Copy link
Contributor

bmorris3 commented Sep 4, 2015

@cdeil Would this be ok to stick in the FAQ section on a new page? I can't think of a more appropriate place.

bmorris3 added a commit to bmorris3/astroplan that referenced this issue Sep 4, 2015
@bmorris3 bmorris3 self-assigned this Sep 4, 2015
bmorris3 added a commit that referenced this issue Sep 4, 2015
Adding Help & Contribute page [#101]
@eteq
Copy link
Member

eteq commented Sep 4, 2015

Looks like this was done in #106 - I'll close this, but if we want more, this can always be re-opened.

@eteq eteq closed this as completed Sep 4, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants