Skip to content

Latest commit

 

History

History
135 lines (68 loc) · 4.18 KB

CONTRIBUTING.md

File metadata and controls

135 lines (68 loc) · 4.18 KB
Raw

Contribution Guide

Thank you for considering contributing to CampX! We welcome contributions from the community to help improve and expand the project. Whether you're fixing bugs, adding new features, improving documentation, or sharing ideas, your contributions are highly appreciated.

How to Contribute

1. Fork the Repository

Start by forking the CampX repository to your GitHub account.

1. Navigate to the CampX repository.

2. Click the "Fork" button at the top right of the page.

2. Clone Your Fork

Once you've forked the repository, clone it to your local machine.

git clone https://github.com/Vignesh025/CampX.git

cd CampX

3. Create a New Branch

Create a new branch for your contribution. It's good practice to name your branch based on the feature or fix you're working on.

git checkout -b feature/your-feature-name

4. Make Your Changes

Make the necessary changes to the codebase, documentation, or any other part of the project.

  • Ensure your code follows the existing style and conventions.

  • Write clear and concise commit messages that describe your changes.

  • If you're adding a new feature or making a significant change, consider updating the documentation as well.

5. Test Your Changes

Before submitting your changes, make sure they work as expected:

  • Run the existing tests to ensure you haven't broken anything.

  • Add new tests if applicable.

6. Commit Your Changes

Once you're satisfied with your changes, commit them to your branch.

git add .

git commit -m "Add [feature/fix]: [brief description of your changes]"

7. Push to Your Fork

Push your changes to your forked repository.

git push origin feature/your-feature-name

8. Open a Pull Request

Submit a pull request (PR) to the main CampX repository.

1. Go to your forked repository on GitHub.

2. Click the "New Pull Request" button.

3. Ensure that the base branch is test and the compare branch is your feature branch.

4. Provide a clear and concise description of your changes in the PR template.

9. Review Process

Your pull request will be reviewed by the maintainers of CampX. They may request changes or ask for further clarification. Be responsive to feedback and make any necessary updates.

10. Merge and Celebrate

Once your pull request is approved and merged, congratulations! You've successfully contributed to CampX. Your contribution will be credited in the project's contributors list.

Contribution Guidelines

Code of Conduct

Please follow our Code of Conduct to ensure a welcoming and inclusive environment for everyone.

Coding Standards

  • Follow the existing coding style and conventions.

  • Write clear, maintainable, and well-documented code.

  • Use meaningful commit messages.

Documentation

If your contribution changes any functionality or adds a new feature, please update the relevant documentation. This helps other users and contributors understand how to use the new functionality.

Bug Reports

If you find a bug, please report it by opening an issue. Provide as much detail as possible, including steps to reproduce the issue, expected behavior, and screenshots if applicable.

Feature Requests

We're always looking to improve CampX. If you have an idea for a new feature, open an issue with the tag [FEATURE] and provide a detailed description of your idea.

UI Enhancements

We're always looking to improve the UI of CampX. If you have an idea for enhancing the UI of CampX, open an issue with the tag [UI] and provide screenshots of the improvement.

Security Vulnerabilities

If you discover a security vulnerability, please report it directly via the issue tracker or by contacting us at CampX. Do not post security issues publicly.

Thank You!

Thank you for your interest in contributing to CampX! We're excited to see how you can help improve the platform for everyone.

If you have any questions or need help, feel free to reach out by opening an issue or contacting us directly at CampX Discord channel.