Skip to content

Latest commit

 

History

History
93 lines (67 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

93 lines (67 loc) · 3.25 KB

Ample Launchpad | Contribution Guidelines

Thank you for considering contributing to our project! By contributing, you help us improve and grow. To ensure a smooth process for everyone involved, please take a moment to review these guidelines.

Table of Contents

  1. How to Contribute
  2. Reporting Issues
  3. Submitting Pull Requests
  4. Coding Standards
  5. Commit Messages
  6. Branching Model
  7. Review Process
  8. License

How to Contribute

Prerequisites

Steps to Contribute

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine. 
    git clone https://github.com/your-username/repository-name.git
  3. Create a new branch for your changes. 
    git checkout -b feature/branch-name
  4. Make your changes in the codebase.
  5. Commit your changes with a descriptive commit message.
  6. Push your changes to your forked repository. 
    git push origin feature/branch-name
  7. Create a Pull Request (PR) from your forked repository to the main repository.

Reporting Issues

If you find a bug or have a feature request, please create an issue. Make sure to include a clear title and description. Provide as much detail as possible to help us understand and address the issue.

Submitting Pull Requests

Checklist Before Submitting a PR

  • Ensure your code follows the project's coding standards.
  • Make sure there are no conflicts with the base branch.
  • Add tests for your changes (if applicable).
  • Update the documentation (if applicable).

Creating a PR

  1. Go to the original repository and navigate to the "Pull Requests" tab.
  2. Click the "New Pull Request" button.
  3. Select the develop branch and compare it with your feature branch.
  4. Provide a descriptive title and a detailed description of your changes.
  5. Submit the PR for review.

Coding Standards

  • Follow the project's coding style (e.g., linting rules, naming conventions).
  • Write clear, concise, and maintainable code.
  • Include comments where necessary, especially for complex logic.
  • Ensure your code is well-documented.

Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Capitalize the first letter of the subject line.
  • Limit the subject line to 50 characters or less.
  • Separate the subject from the body with a blank line.
  • Use the body to explain what and why vs. how.

Branching Model

  • main: The production branch.
  • develop: The branch for ongoing development.

Review Process

  1. Once you submit a PR, it will be reviewed by one or more maintainers.
  2. Reviewers may request changes or approve the PR.
  3. Address any feedback and push additional commits if necessary.
  4. Once approved, the PR will be merged into the appropriate branch.

License

By contributing to this project, you agree that your contributions will be licensed under the project's license.