Contributing

Contributing

By following these guidelines, you can help us maintain a collaborative and inclusive community.

1. How to Contribute

Contributing to our projects is easy! Follow these steps to get started:

  • Fork or clone the repository.

  • Create a new branch for your feature or bug fix.

  • Make your changes and commit them with clear and concise messages.

  • Push your changes to your branch.

  • Submit a pull request, explaining the changes you made.

More about code conventions

2. Code of Conduct

Please review and adhere to our Code of Conduct to ensure a positive and inclusive environment for everyone.

3. Reporting Bugs

If you encounter a bug, open an issue following these guidelines:

  • Include a detailed description of the bug and steps to reproduce it.

  • Attach relevant screenshots or error messages (not nessesary, but often can be helpful).

4. Suggesting Enhancements

Have a great idea for an enhancement? Follow these steps:

  • Clearly describe the proposed enhancement.

  • Provide any additional context or examples.

5. Code Contribution

When contributing code, follow these guidelines:

  • Adhere to the coding standards and conventions outlined in code-conventions.md

  • Ensure your code is well-documented.

  • Write tests for your code if applicable.

  • Make small, focused commits with clear messages.

6. Pull Request Process

Follow these steps when submitting a pull request:

  • Ensure your branch is up-to-date with the latest changes from the main branch.

  • Include relevant tests for your changes.

  • Update the documentation if necessary.

  • Ensure your code passes all automated checks.

  • Request reviews from other contributors.

7. Review Process

All contributions go through a review process:

  • Reviewers will provide feedback and request changes if needed.

  • Address feedback and make necessary adjustments.

  • Once approved, your pull request will be merged.

8. Code of Conduct Enforcement

We take our Code of Conduct seriously. Any violations should be reported to the.sead.club@gmail.com All reports will be kept confidential.

9. Attribution

Thank you for contributing to the SEAD Club! Your efforts help us build a thriving and collaborative community.