Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (28 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 2.63 KB

Contributing to Astra - Automated Survey observaTory Robotised with Alpaca

Thank you for your interest in contributing to Astra! We appreciate any contributions that can help improve the software and make it even more powerful for observatory automation.

Ways to Contribute

There are several ways you can contribute to Astra:

  • Bug Reports: If you encounter any issues or bugs while using Astra, please open a new issue on the GitHub repository. Include as much detail as possible, including steps to reproduce the issue.
  • Feature Requests: If you have ideas for new features or enhancements, we would love to hear them! Open a new issue on GitHub and describe the feature you would like to see.
  • Code Contributions: If you are a developer and would like to contribute code to Astra, you can fork the repository, make your changes, and submit a pull request. Make sure to follow the coding style and guidelines outlined below.
  • Documentation: Improving the documentation is always valuable. If you find any areas that can be clarified or expanded, submit a pull request with your proposed changes.
  • Testing: Help us ensure the stability and reliability of Astra by testing the software and reporting any issues you encounter.

Guidelines for Code Contributions

When contributing code to Astra, please follow these guidelines:

  • Fork the repository and create a new branch for your contribution.
  • Make your changes, following the coding style and best practices used in the existing codebase.
  • Write clear, concise, and informative commit messages.
  • Test your changes thoroughly to ensure they don't introduce any new issues.
  • If your changes modify the behavior of Astra or introduce new features, update the relevant documentation accordingly.
  • Submit a pull request to the main repository. Provide a detailed description of your changes and explain why they are beneficial.

Coding Style

  • Use consistent indentation (4 spaces) throughout the codebase.
  • Follow the PEP 8 style guide for Python code.
  • Write clear and meaningful variable and function names.
  • Add comments to explain complex logic or algorithms.

Getting Help

If you need any assistance or have questions about contributing to Astra, feel free to reach out to our development team in the issues tab. We are here to help!

Code of Conduct

Please note that by contributing to Astra, you are expected to adhere to the Code of Conduct of this project.

We appreciate your contributions and look forward to working together to make Astra an exceptional observatory control software!