Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 3.04 KB

Contributing to Gitbraltar

Thank you for your interest in contributing to Gitbraltar! We welcome contributions from everyone who wants to help improve the project and make it even better. By contributing, you can help us provide accurate and up-to-date information about Gibraltar's location and various aspects.

We appreciate all types of contributions, including bug reports, feature requests, documentation improvements, and code contributions. To ensure a smooth and collaborative experience for everyone involved, please review and follow the guidelines below.

Getting Started

To get started with contributing to Gitbraltar, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local development environment.
  3. Create a new branch for your contributions.
  4. Make your desired changes or additions.
  5. Commit and push your changes to your forked repository.
  6. Submit a pull request (PR) from your branch to the main repository.

Issue Reporting

If you encounter any bugs, issues, or have suggestions for improvements, please let us know by opening an issue on the GitHub repository. When creating an issue, provide as much detail as possible, including:

  • A clear and descriptive title.
  • Steps to reproduce the issue, if applicable.
  • Expected and actual behavior.
  • Relevant screenshots or error messages.

Pull Requests

We welcome pull requests for bug fixes, new features, and other improvements. To submit a pull request:

  1. Ensure that your code adheres to the project's coding standards and style guidelines.
  2. Include clear and concise commit messages that describe your changes.
  3. Test your changes thoroughly to ensure they do not introduce new issues.
  4. Document any new or modified functionality in the project's documentation.

Code Style and Guidelines

To maintain a consistent codebase and make collaboration easier, please adhere to the following guidelines:

  • Follow the existing code style and formatting conventions.
  • Write meaningful variable and function names that accurately describe their purpose.
  • Keep the codebase clean, concise, and readable.
  • Comment your code when necessary, especially for complex or non-obvious logic.

Licensing

By contributing to Gitbraltar, you agree that your contributions will be licensed under the project's open-source license. You retain the copyright to your contributions while granting us a perpetual, worldwide, non-exclusive, royalty-free license to use, reproduce, modify, display, and distribute your contributions.

Code of Conduct

We expect all contributors to adhere to the project's Code of Conduct. By participating, you are expected to uphold this code of conduct and treat all individuals with respect and kindness.

Get in Touch

If you have any questions, concerns, or need further assistance, feel free to reach out to us. You can contact us through GitHub by creating an issue or by email.

Thank you for contributing to Gitbraltar! Your contributions are greatly appreciated.

Happy coding!