Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

43 lines (25 loc) · 2.44 KB

Contribution Guidelines Face with Monocle

Thank you for considering contributing to our case study project! Please note that any contributions are welcome starting May 2024. At this time, the purpose of this case study as a university project will have ended, and it will continue from thereon as a passion research project to expand and document our Linux OS knowledge. We appreciate any help, and to make the process smooth and productive, please follow these guidelines:

Reporting Bugs

  • If you encounter any faulty information or misconceptions, please check the existing discussions to see if it has already been reported. If not, please feel free to start a discussion by providing a detailed description of the problem.

Research Expansion

  • We welcome suggestions for new sections or enhancements. Before submitting a suggestion, please ensure it's not already in the table of contents or being processed in existing discussions. Provide a clear description of the proposed enhancement and its potential benefits.

Code Contributions

  • Fork the repository and create a new branch for your feature or bug fix.
  • Make your changes, ensuring adherence to our documentation style and requirements.
  • Validate your changes thoroughly.
  • Open a pull request against the main branch, clearly describing the changes introduced and referencing any related issues.

Review

  • All contributions will undergo review. Be prepared to address feedback and make necessary revisions to your additions.
  • Maintain a respectful and constructive tone during review discussions.

Documentation

  • Help improve project documentation by fixing typos, clarifying explanations, or adding missing information.

Be Respectful

  • Respect the opinions and contributions of others, even if they differ from your own.
  • Avoid personal attacks, harassment, or offensive language.

License

  • By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.

Code of Conduct

If you have any questions or need clarification on anything, feel free to reach out to the project maintainers.