Skip to content

Latest commit

 

History

History
77 lines (53 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

77 lines (53 loc) · 2.67 KB

Contributing to Solved by Hand

We welcome contributions to the Neural Network Exercises repository! If you have suggestions for improvement or want to contribute new exercises, please follow the guidelines below.

Code of Conduct

Our community adheres to a code of conduct that all contributors must follow. Please read CODE_OF_CONDUCT.md to ensure a harmonious and welcoming environment for all.

How to Contribute

  1. Fork the Repository Start by forking the repository to your own GitHub account.

  2. Clone the Forked Repository Clone your forked repository to your local machine:

git clone https://github.com/jeremy-london/solved-by-hand.git
cd solved-by-hand
  1. Create a Feature Branch Create a new branch for your feature or fix:
git checkout -b feature/your_feature_name

  1. Make Your Changes Implement your changes, adhering to the existing coding style and practices.

  2. Commit Your Changes Make sure your commits follow our commit message conventions for readability and consistency:

Prefix your commit message with one of the following types:

  • feat: for new features
  • fix: for bug fixes
  • docs: for documentation and examples
  • style: for formatting, missing semi colons, etc; no code change
  • refactor: for refactoring existing code
  • test: for adding missing tests
  • chore: for maintenance tasks
git commit -m "feat: Add new activation function"
git commit -m "fix: Correct typo in README"
git commit -m "docs: Update comments in code"
git commit -m "test: Add unit test for custom layer"
  1. Push to Your Branch Push your changes to your GitHub repository:
git push origin feature/your_feature_name
  1. Create a Pull Request Go to the original repository and create a pull request from your feature branch. Please provide a detailed description of your changes and reference any relevant issues.

Pull Request Review

Once you submit your pull request, one of the maintainers will review it. We may suggest changes or improvements to ensure quality and consistency with the rest of the exercises.

After Your Pull Request is Merged

After your pull request is merged, you can pull the changes from upstream to your local repo and delete your extra branch(es).

Additional Guidelines

  • Ensure that any new code follows the existing structure and naming conventions.
  • Comment your code where necessary to explain complex logic.
  • Update the README with details of changes to the interface or new exercise additions.
  • Maintain the quality of the exercises and test any changes thoroughly before submitting.

Thank you for contributing to the Neural Network Exercises project!