Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.49 KB

CONTRIBUTIONS.md

File metadata and controls

36 lines (22 loc) · 1.49 KB
Raw

I appreciate your interest in contributing to our project. Before you get started, please take a moment to review the following guidelines.

Getting Started

  1. Fork the repository.
  2. Clone your fork locally: git clone https://github.com/apple-fritter/celebration.git
  3. Create a new branch for your changes: git checkout -b feature-name
  4. Make your changes and commit them: git commit -m "Description of your changes"
  5. Push your changes to your fork: git push origin feature-name
  6. Open a pull request against the main branch.

Code Style

Follow the coding style used in the project. If there is a specific style guide, please adhere to it. If not, maintain consistency with the existing code.

Testing

Ensure that your changes do not break existing functionality. If applicable, provide unit tests for your code.

Documentation

Update the documentation if your changes affect it. This includes the README.md file, code comments, and any other relevant documentation.

Commit Messages

Write clear and concise commit messages. Use the present tense and follow this format: "Add feature," "Fix bug," "Update documentation," etc.

Pull Request Guidelines

  1. Provide a clear and detailed description of your changes.
  2. Reference the issue number that your pull request addresses, if applicable.
  3. Ensure that your branch is up to date with the latest changes from the main branch.

Code of Conduct

Please adhere to our Code of Conduct in all interactions.