Skip to content

Latest commit

 

History

History
67 lines (39 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

67 lines (39 loc) · 2.65 KB
Raw

Contributing to Scaffolder

We appreciate your interest in contributing to our project. By contributing, you can help make Scaffolder better and more useful.

Ways to Contribute

  • Reporting Issues: If you encounter any bugs, unexpected behavior, or have suggestions for improvements, please open an issue on our GitHub repository. Provide as much detail as possible, including steps to reproduce the issue.

  • Feature Requests: If you have ideas for new features or enhancements, feel free to share them by creating a new issue on GitHub.

  • Pull Requests: We welcome code contributions! If you want to add a feature, fix a bug, or improve the documentation, submit a pull request. Make sure your code adheres to our coding standards and includes appropriate tests.

  • Documentation: Good documentation is crucial for a successful project. You can help by improving our existing documentation or creating new content to make it more comprehensive.

  • Testing: Contributing by testing the project, whether it's running test cases, performing manual tests, or providing feedback, is invaluable for maintaining the project's quality.

  • Code Reviews: Reviewing pull requests and providing constructive feedback helps maintain code quality and fosters a collaborative community.

Getting Started

To contribute to Scaffolder, follow these steps:

  1. Fork the Scaffolder repository to your GitHub account.

  2. Clone the forked repository to your local machine:

git clone https://github.com/dl-tg/scaffolder.git
  1. Create a new branch for your changes:
git checkout -b my-feature

  1. Make your changes

  2. Commit your changes:

git commit -m "Add my feature"
  1. Push your changes to your forked repository:
git push origin my-feature
  1. Open a pull request on the master Scaffolder repository. Clearly describe your changes and their purpose. Add any relevant information that can help reviewing it.

Coding Guidelines

Follow the Go Code Review Comments to maintain consistency across the project. Write clear, concise, and well-documented code. Use comments where necessary to explain complex logic. Ensure your code passes the project's existing tests and add new tests to cover your changes.

Code of Conduct

We expect all contributors to adhere to the Code of Conduct to create a respectful and inclusive community.

License

By contributing to Scaffolder, you agree that your contributions will be licensed under the MIT License.

Thank you for your interest in Scaffolder. We look forward for your contributions!