Skip to content

Add contributing guidelines and pull request template #234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing to DateTimeExtensions

Thank you for considering contributing to DateTimeExtensions! We welcome contributions from the community to help improve the project. Please take a moment to review these guidelines before you start contributing.

## Code Style

- Follow the existing code style and conventions used in the project.
- Use meaningful variable and function names.
- Write clear and concise comments where necessary.
- Ensure your code is properly formatted and indented.

## Testing

- Write tests for any new features or bug fixes.
- Ensure that all tests pass before submitting a pull request.
- Use the existing test framework and follow the testing conventions used in the project.

## Pull Request Process

1. Fork the repository and create a new branch for your contribution.
2. Make your changes in the new branch.
3. Write tests for your changes and ensure all tests pass.
4. Commit your changes with a clear and descriptive commit message.
5. Push your changes to your forked repository.
6. Submit a pull request to the main repository.

## Reporting Bugs and Requesting Features

- Use GitHub issues to report bugs and request features.
- Provide as much detail as possible when reporting a bug or requesting a feature.
- Include steps to reproduce the bug, if applicable.
- Be respectful and considerate in your communication.

Thank you for your contributions!
35 changes: 35 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Pull Request Template

## Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes #(issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

## Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules

## Additional Information

Please add any other information or screenshots that are relevant to the change here.

## Follow the guidelines

Please make sure to follow the guidelines in [CONTRIBUTING.md](CONTRIBUTING.md).
7 changes: 2 additions & 5 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be repor

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution
## How to Submit Pull Requests

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
To submit a pull request, please follow the guidelines in the [PULL_REQUEST_TEMPLATE.md](.github/PULL_REQUEST_TEMPLATE.md) file.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ We welcome contributions! Here's how you can help:

To add new holiday definitions, please prefix culture-specific holidays with the country name (e.g., "USA_IndependenceDay").

For more details, please refer to our [CONTRIBUTING.md](.github/CONTRIBUTING.md) file.

## 📖 Documentation

For more detailed information, visit our [official documentation](http://www.kspace.pt/DateTimeExtensions/).
Expand Down