Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

58 lines (42 loc) · 3.96 KB

Contribute

We love contributions! dkist is open source, built on open source, and we'd love to have you hang out in our community.

Imposter syndrome disclaimer: We want your help. No, really.

There may be a little voice inside your head that is telling you that you're not ready to be an open source contributor; that your skills aren't nearly good enough to contribute. What could you possibly offer a project like this one?

We assure you - the little voice in your head is wrong. If you can write code at all, you can contribute code to open source. Contributing to open source projects is a fantastic way to advance one's coding skills. Writing perfect code isn't the measure of a good developer (that would disqualify all of us!); it's trying to create something, making mistakes, and learning from those mistakes. That's how we all improve, and we are happy to help others learn.

Being an open source contributor doesn't just mean writing code, either. You can help out by writing documentation, tests, or even giving feedback about the project (and yes - that includes giving feedback about the contribution process). Some of these contributions may be the most valuable to the project as a whole, because you're coming to the project with fresh eyes, so you can see the errors and assumptions that seasoned contributors have glossed over.

Note: This disclaimer was originally written by Adrienne Lowe for a PyCon talk, and was adapted by dkist based on its use in the README file for the MetPy project.

Provide Feedback

We could always use more voices and opinions in the discussions about dkist and its development from both users and developers. You may want to suggest a new feature or tell us about how something is not working in the manner you would expect it to. There are a number of ways to make your voice heard and we would love to hear from you.

We strongly recommend that your first port of call would be to our lovely matrix channel. Here you can get in easily get in touch with developers or users for questions or support.

Report Bugs

If you run into unexpected behavior or run into a bug we urge you to please report it. All bugs are kept track of on our issue tracker. You can add a bug report there or you can report it on matrix channel. Ideally, we would like a short code example so we can reproduce the bug on our own machines.

Provide Code

If you are interested in contributing fixes, code or documentation to dkist please have a read of the SunPy's newcomers guide as it's an excellent introduction to contributing.

dkist uses a distributed version control system called git and the code is hosted on GitHub. To get started, create an account on github and fork dkist then submit your changes via a pull request. If you are unfamiliar with this style of development, Astropy provide a sample workflow but you can also find lots of tutorials online. You can browse our issue list to find something that you can tackle. Please leave a comment on the issue on GitHub and stop by the matrix channel to let people know what you are planning to work on.