Thank you for considering contributing to NextGuild, a library that simplifies interaction with the Guilded API! Contributions will help make this library more useful and easier to work with.
To contribute to NextGuild, start by:
- Forking the repository.
- Cloning the forked repository to your local machine.
- Installing the required dependencies.
- Creating a new branch for your changes.
-
Follow the coding style: Adhere to the coding style used throughout the project. Consistency is essential for code readability and maintainability.
-
Create an issue before starting work: If you're planning to add a new major feature, or fix a bug, please open an issue describing what you plan to do. This helps avoid duplicate work and allows the community to provide feedback on your idea.
-
Write tests: Write tests for your changes to ensure your code works as expected and to prevent future regressions.
-
Update the documentation: If your changes involve adding new features or modifying existing ones, make sure to update the documentation accordingly.
-
Keep your commits focused: Each commit should address a single concern or feature. This makes the commit history easier to understand and navigate.
-
Write descriptive commit messages: Write clear and concise commit messages that describe the changes you've made. This helps other contributors understand the purpose of your changes.
- Make sure your changes are based on the latest version of the main branch.
- Ensure your changes pass all tests and follow the coding style.
- Create a pull request against the main branch of the repository.
- Provide a clear and concise description of your changes in the pull request.
- Address any feedback provided.
If you have questions, need help, or want to discuss ideas with the community, join the conversation on our Guilded server!