Skip to content

Collaboration Guidelines

Thomas Behan edited this page May 27, 2024 · 7 revisions

Below are some guidelines to ensure a smooth collaboration and productivity.

Code of Conduct

Please adhere to our Code of Conduct, which promotes a respectful and inclusive atmosphere. Discrimination, harassment, or any inappropriate behaviour will not be tolerated.

Communication Channels

  • Issues: Use GitHub issues for bug reports, feature requests, or discussions about potential improvements. Check for existing issues first to avoid duplicates.
  • Pull Requests: Propose code changes by creating a pull request (PR), following the provided PR template and including a clear description of your changes.
  • Discussions: Use the discussion board for questions, idea sharing, and collaboration. Ensure you use appropriate categories and labels.

Contributing Process

  1. Fork and Clone: Fork the repository to your account and clone it locally.
  2. Create a Branch: Start a new branch for each feature or fix, naming it descriptively.
  3. Commit Changes: Commit your changes with meaningful messages following our guidelines.
  4. Stay Updated: Regularly sync your fork with the main repository to avoid conflicts.
  5. Test Your Changes: Ensure your changes pass all tests and adhere to coding standards.
  6. Submit a Pull Request: Once ready, submit a PR to the main repository, respond to feedback, and make required updates.

Coding Standards and Best Practices

  • Adhere to our coding style and guidelines.
  • Write clear, concise, and well-documented code.
  • Comment complex or unclear sections of your code.
  • Ensure new changes are well-tested.
  • Keep commits focused and well-described.

By following these guidelines, we can maintain a productive and welcoming environment. We're excited to see your contributions to LesNet!