Skip to content

Commit

Permalink
[doc] add contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
herumi committed May 15, 2024
1 parent cf1038c commit e8b22e5
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to mcl

Thank you for considering contributing to the mcl project. This document provides guidelines on how to contribute.

## Bug Reports and Feedback

If you find a bug, have a feature request, or have questions, please open an issue. Include the following information:

- Detailed description of the problem
- Steps to reproduce
- Expected behavior
- Actual behavior
- Environment details (OS, compiler version, etc.)

## Creating Pull Requests

If you want to add features or make fixes, follow these steps to create a pull request:

1. Fork the repository
2. Create a new branch: `git checkout -b my-feature-branch`
3. Make your changes
4. Run tests and ensure all tests pass
5. Commit your changes: `git commit -am 'Add new feature'`
6. Push the branch: `git push origin my-feature-branch`
7. Create a pull request

When creating a pull request, clearly describe the changes and include any related issue numbers.

## License

mcl is released under the BSD-3-Clause License. Any code contributions will be licensed under the same license.

0 comments on commit e8b22e5

Please sign in to comment.