Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (30 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 1.39 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to the sys_optimizer project! Please follow these guidelines to ensure a smooth and effective contribution process.

How to Contribute

  1. Fork the Repository: Start by forking the repository to your own GitHub account.
  2. Clone Your Fork: Clone your forked repository to your local machine: 
    git clone https://github.com/YOUR_USERNAME/sys_optimizer.git
  3. Create a Branch: Create a new branch for your feature or bug fix: 
    git checkout -b your-feature-branch
  4. Make Your Changes: Make your changes in the codebase.
  5. Commit Your Changes: Commit your changes with a descriptive message: 
    git commit -m "Add a descriptive message"
  6. Push to GitHub: Push your changes to your fork: 
    git push origin your-feature-branch
  7. Create a Pull Request: Go to the original repository and create a pull request. Be sure to detail the changes you made and why.

Code Style

  • Follow the existing style of the project.
  • Ensure that your code is properly formatted.

Testing

All contributions should come with appropriate tests. Run the tests before submitting your pull request.

Questions or Suggestions

If you have questions or suggestions, please feel free to reach out via issues or discussions in the repository.

Thank you for your contributions!