Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 2.09 KB
Raw

Contributing to BrightIntosh

Thank you for your interest in contributing to BrightIntosh! We welcome contributions from everyone, and here are some guidelines to get you started.

Creating Issues

If you encounter a bug, have a feature request, or want to discuss any aspect of BrightIntosh, please follow these steps to create an issue:

  1. Go to the Issues section on our GitHub repository.
  2. Click the "New Issue" button.
  3. Fill in a clear and detailed description of the problem or feature request.
  4. Include any relevant information such as your operating system, Swift version, and steps to reproduce the issue.

Creating Pull Requests

We welcome contributions in the form of pull requests (PRs). If you want to contribute code or fixes, please follow these steps:

  1. Fork the BrightIntosh repository to your GitHub account.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes (git checkout -b feature/your-feature-name).
  4. Make your changes and commit them with clear and concise commit messages.
  5. Push your changes to your forked repository (git push origin feature/your-feature-name).
  6. Create a pull request from your branch to the main branch of the main BrightIntosh repository.

Commit Messages

Please follow these guidelines for writing meaningful commit messages:

  • Use a concise and descriptive message.
  • Start the message with a verb (e.g., "Fix," "Add," "Update").
  • Include context and reference any related issues (e.g., "Fixes #123").

Code of Conduct

We want BrightIntosh to be an open and welcoming community for all contributors. Please be respectful and considerate of others. Discrimination, harassment, and offensive behavior will not be tolerated.

Remember, we're all here to learn and collaborate. Let's make BrightIntosh better together!

If you have any questions or need assistance, feel free to reach out in the GitHub discussions or X (Twitter).

Thank you for contributing to BrightIntosh!