Skip to content

Latest commit

 

History

History
50 lines (30 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

50 lines (30 loc) · 2.25 KB

Contributing Guidelines for ASI-InSPACe-CANSAT-2022-Team-Astropeep

Welcome to the ASI-InSPACe-CANSAT-2022-Team-Astropeep repository! We appreciate your interest in contributing to our research project. Before you get started, please take a moment to review the following guidelines.

How to Contribute

Reporting Issues

If you encounter any issues with the methodology, its data, or related materials, please open an issue on GitHub. When reporting issues, please include:

  • A clear and descriptive title.
  • Detailed steps to reproduce the issue.
  • Expected behavior and actual behavior.
  • Any relevant screenshots or error messages.

Submitting Changes

If you would like to contribute to the repository:

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your changes: git checkout -b my-branch-name.
  3. Make your modifications and commit them with a clear message explaining your changes.
  4. Push your changes to your fork: git push origin my-branch-name.
  5. Submit a pull request (PR) to the main repository's main branch.
  6. Provide a detailed description of your changes in the PR.

Crediting Us

If you use our research paper, data, or other materials in your own work, we kindly request that you credit us appropriately. Include a citation or acknowledgment pointing to this repository and our contributors. This helps us track the impact of our work and fosters collaboration.

Code of Conduct

Please note that we adhere to the Contributor Covenant Code of Conduct. By participating in this project, you agree to abide by its terms.

Style Guidelines

  • For code contributions, follow the existing coding style and formatting conventions.
  • For documentation and research paper content, adhere to the provided templates and style guide.

Licensing

Make sure any contributed code, documentation, or other materials are compatible with the repository's existing licenses. Include a brief statement about licensing in your pull request if necessary.

Contact

If you have any questions that aren't addressed in the documentation, feel free to reach out to us at victorazad7834@gmail.com.

Acknowledgments

Thank you for contributing to ASI-InSPACe-CANSAT-2022-Team-Astropeep! Your help is invaluable to improving our work.