Skip to content

Latest commit

 

History

History
68 lines (39 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

68 lines (39 loc) · 2.46 KB

Contributing to Advent of Code

Thank you for considering contributing to Advent of Code! We appreciate your time and effort in making this project better. By contributing, you agree to abide by the Code of Conduct. Please take a moment to review these guidelines before getting started.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How to Contribute

We welcome contributions in the form of bug reports, feature requests, documentation improvements, and code contributions. To contribute, follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone the forked repository to your local machine:

    git clone https://github.com/amedee/adventofcode.git

  3. Create a new branch for your changes:

    git checkout -b feature/your-feature

  4. Make your changes and commit them with descriptive commit messages:

    git add .
git commit -m "Add your changes here"

  5. Push your changes to your fork:

    git push origin feature/your-feature

  6. Create a Pull Request (PR) against the main branch of the original repository.

  7. Ensure your PR title and description clearly describe your changes. Include information on the problem you are solving, and how your changes address it.

Code Style

Follow the existing code style in the project. If the project uses a specific coding style or linting configuration, ensure your changes adhere to it.

Testing

If applicable, write tests for your changes and make sure existing tests pass.

Documentation

Update the documentation if your changes affect it. This includes updating the README, adding new documentation files, or modifying existing ones.

Issues

If you find a bug or have a feature request, please open an issue. Provide as much detail as possible, including the version of the project you are using, operating system, and steps to reproduce the issue.

Review Process

Pull Requests will be reviewed by the maintainers. Feedback, suggestions, and changes may be requested before your contribution is merged.

Thank you

Thank you for contributing to Advent of Code! Your time and efforts are valued. We appreciate your help in making this project a success.

Happy coding!