Skip to content

Latest commit

 

History

History
92 lines (63 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

92 lines (63 loc) · 3.38 KB

CONTRIBUTING.md

Contribution Guidelines

Thank you for your interest in contributing to our project! To ensure a smooth collaboration, please follow these guidelines when making contributions.

How to Contribute

There are several ways to contribute to the project:

  • Reporting Bugs: Use the Issue Template to report bugs.
  • Suggesting Features: Open an issue to propose new features.
  • Contributing Code: Follow the steps below to contribute code.

Getting Started

  1. Fork the Repository: Create your own copy of the repository by clicking the "Fork" button on GitHub.
  2. Clone Your Fork: Clone your forked repository to your local machine. 
    git clone https://github.com/your-username/astronomy-horoscope.git
  3. Create a Branch: Create a new branch for your feature or bug fix. 
    git checkout -b feature-name

Coding Standards

  • Code Style: Follow the coding standards and style guides for the language you are working with.
  • Comments: Comment your code, especially in complex or hard-to-understand areas.
  • Testing: Write tests for your code and ensure all existing tests pass.

Branch Naming Conventions

  • Use descriptive names for your branches.
  • Examples:
    • feature/add-new-feature
    • bugfix/fix-issue-123
    • docs/update-readme

Pull Request Process

  1. Commit Your Changes: Make your changes and commit them with a descriptive message. 
    git commit -m "Description of the changes"
  2. Push to Your Fork: Push your changes to your forked repository. 
    git push origin feature-name
  3. Create a Pull Request: Open a pull request from your fork to the main repository.

Pull Request Guidelines

  • Fill Out the Template: Use the Pull Request Template to provide all necessary information.
  • Link Related Issues: Reference any related issues in your pull request description.
  • Review Process: Be prepared to make changes based on feedback from code reviewers.
  • Passing Tests: Ensure all tests pass before requesting a review.

Contributing as a Tester

We welcome contributions from testers as well:

  • Code Tester: Test new and existing features, report bugs, and suggest improvements.
  • Beta Tester: Participate in beta testing, provide feedback, and report issues.
  • Security Tester: Conduct security testing and report vulnerabilities.

Supporting the Project

  • Patron: Support the project financially through donations.
  • One-Time Donation: Make a one-time donation to support ongoing development.

Developer Guidelines

  • Development Environment Setup: Instructions for setting up the development environment.
  • Coding Standards: Detailed coding standards and best practices.
  • Pull and Merge Requests: Detailed process for creating and merging pull requests.

Migration Efforts

We are working on migrating the project to modern languages and libraries such as JavaScript, Python, Go, and Swift. Contributions to these efforts are highly appreciated.

Contact Information

For support or inquiries, you can reach the maintainers via:

Thank you for contributing!