Skip to content

Latest commit

 

History

History
108 lines (66 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

108 lines (66 loc) · 3.75 KB

Contributing to Xphyrus

🎉 Thank you for considering contributing to Xphyrus! We welcome contributions from everyone. By participating in this project, you agree to abide by our Code of Conduct.

How Can You Contribute?

There are several ways to contribute to Xphyrus:

  • Report Bugs: If you encounter any bugs, please report them via the GitHub Issues page.
  • Suggest Features: Have an idea for a new feature? We'd love to hear it! Open a feature request on the GitHub Issues page.
  • Write Code: If you're a developer, you can contribute by fixing bugs, adding new features, or improving existing ones.
  • Improve Documentation: Help us improve our documentation, from fixing typos to adding new sections.

Getting Started

1. Fork the Repository

First, fork the repository to your GitHub account.

git clone https://github.com/arya2004/xphyrus.git
cd xphyrus

2. Create a Branch

We follow a branch-based workflow. To start working on an issue or feature, create a new branch from the main branch:

git checkout -b feature/your-feature-name

3. Make Your Changes

Make your changes in your local repository. Ensure that your code follows our coding standards and passes all tests.

4. Commit Your Changes

Commit your changes with a clear and descriptive message:

git add .
git commit -m "Add feature X to support Y"

5. Push Your Changes

Push your branch to your forked repository:

git push origin feature/your-feature-name

6. Create a Pull Request

Go to the original repository on GitHub and create a new Pull Request (PR) from your branch. Provide a clear description of what you've done, including any relevant issue numbers (e.g., "This PR fixes #123").

  • Ensure your PR is linked to an issue: If your PR addresses an existing issue, mention it in the description.

Contribution Guidelines

Coding Standards

Please adhere to the following coding standards:

  • Follow the existing coding style: Use the same indentation, comments, and structure as the existing code.
  • Keep it simple: Avoid unnecessary complexity.
  • Write meaningful commit messages: Commit messages should be concise but descriptive.

Pull Request Guidelines

  • Keep PRs focused: Each PR should address a single issue or feature.
  • Describe your changes: Provide a clear and concise description of what your PR does.
  • Ensure tests pass: All tests should pass before submitting your PR.
  • Get a review: Once your PR is ready, request a review from the project maintainers.

Reporting Bugs

If you find a bug, please open an issue on the GitHub Issues page and include:

  • A clear and descriptive title.
  • A description of the steps to reproduce the issue.
  • The expected behavior.
  • The actual behavior.
  • Any relevant logs, screenshots, or code snippets.

Suggesting Features

If you have a feature request, please open an issue on the GitHub Issues page and include:

  • A clear and descriptive title.
  • A detailed description of the proposed feature.
  • The problem this feature would solve or the use case it would support.
  • Any other relevant information or context.

Code of Conduct

Please note that by participating in this project, you agree to abide by our Code of Conduct.

License

By contributing, you agree that your contributions will be licensed under the same license as the project. This project is licensed under the CC0 1.0 Universal License.

Thank You!

We appreciate your efforts in making Xphyrus better for everyone. Happy coding! 🚀