gbowne1/ClassicOS
2
2
Fork 0
mirror of https://github.com/gbowne1/ClassicOS.git synced 2024-11-22 06:06:52 -08:00
Code Issues 2 Packages Projects 1 Releases Wiki Activity
277837833d
ClassicOS/CONTRIBUTING.md
one mriganka 277837833d Create CONTRIBUTING.md
2023-10-18 23:30:23 +05:30

3.7 KiB
Raw Blame History

Contributing Guidelines

Thank you for considering contributing to our open-source project! We appreciate your interest and support. To ensure a smooth collaboration, please review and adhere to the following guidelines.

Table of Contents

  1. Getting Started
  2. Making Contributions
  3. Submitting Changes
  4. Community and Communication
  5. Code of Conduct

Getting Started

Prerequisites

Before you start contributing, please make sure you have the following:

  • Git installed
  • A GitHub account
  • A text editor or integrated development environment (IDE) of your choice
  • Knowledge of the programming language(s) used in this project

Fork the Repository

Fork our repository by clicking the "Fork" button on the top right of the repository page. This will create a copy of the project in your GitHub account.

Clone the Repository

After forking the repository, clone it to your local machine using the following command, replacing [your-username] with your GitHub username:

git clone https://github.com/[your-username]/[repository-name].git

Making Contributions

Branches

Create a new branch for your work. It's important to keep your changes isolated from the main or master branch to prevent conflicts. Name your branch descriptively, such as feature/your-feature-name or bugfix/issue-number.

git checkout -b feature/your-feature-name

Coding Standards

Please follow the coding standards and style guide of the project. If there are no established standards, maintain consistency with the existing codebase.

Commit Messages

Write clear, concise, and meaningful commit messages. A good commit message should:

  • Begin with a verb in the imperative mood (e.g., "Add," "Fix," "Update").
  • Be concise and focused on a single change.
  • Reference related issues or pull requests, if applicable.

Example: "Fix #123: Add validation for user email input"

Testing

Make sure your changes do not break existing functionality. Write tests for new features and update existing tests as needed.

Submitting Changes

Pull Requests

When your contribution is ready, open a pull request (PR) from your branch to the main repository's branch (e.g., main or master). Be sure to:

  • Give the PR a descriptive title.
  • Provide a clear and detailed description of your changes.
  • Reference related issues, if any.
  • Be prepared to respond to feedback and make necessary adjustments.

Issues

If you find a bug, have a suggestion, or want to work on an issue, please check the project's issue tracker. If the issue doesn't exist yet, feel free to open a new one to discuss the problem or feature request.

Community and Communication

Join our community on GitHub Discussions or our Discord/Slack channel to connect with other contributors and maintainers. This is the place to seek help, discuss ideas, and stay updated on project developments.

Code of Conduct

Please adhere to our Code of Conduct to ensure a welcoming and inclusive environment for all contributors.

Thank you for your interest in contributing to our project! Your contributions make a significant impact on the success and growth of the project.