Thank you for considering contributing to Structure-Walker! We welcome contributions from the community to improve and enhance the project. Please follow the guidelines below to ensure a smooth contribution process.
If you find a bug or have a suggestion, please follow these steps:
-
Check Existing Issues: Before submitting a new issue, please check the issue tracker to see if the problem has already been reported.
-
Submit an Issue: If you don’t find an existing issue, create a new one with a clear description of the problem or suggestion. Include relevant details such as error messages or screenshots if applicable.
To contribute code, follow these steps:
-
Fork the Repository: Click the "Fork" button at the top right of the repository page to create your own copy of the project.
-
Clone Your Fork: Clone your forked repository to your local machine:
git clone https://github.com/intercepted16/structure-walker.git
-
Create a New Branch: Create a new branch for your changes:
git checkout -b feature-branch-name
-
Make Changes: Make your changes and commit them with a descriptive message:
git add . git commit -m "Describe your changes"
-
Push Changes: Push your changes to your forked repository:
git push origin feature-branch-name
-
Submit a Pull Request: Go to the original repository and submit a pull request from your branch. Provide a clear description of the changes and why they are being made.
-
Code Style: Follow the existing coding style of the project. For C code, adhere to the style guidelines used in the repository. For Go code, use
gofmtto format your code. -
Documentation: Update documentation as needed to reflect your changes. Ensure that code comments are clear and helpful.
-
Testing: Ensure that your changes are covered by tests and that all tests pass. If you are adding new features, consider adding new tests.