|
| 1 | +--- |
| 2 | +id: contributing-guidelines |
| 3 | +title: Contributing Guidelines |
| 4 | +sidebar_label: Contributing Guidelines |
| 5 | +sidebar_position: 5 |
| 6 | +--- |
| 7 | + |
| 8 | +Thank you for considering contributing to CodeHarborHub! We welcome contributions from everyone. Whether you're a seasoned developer or just starting out, there are many ways to get involved and help improve CodeHarborHub. This document outlines the guidelines for contributing to this project. |
| 9 | + |
| 10 | +## How to Contribute |
| 11 | + |
| 12 | +To contribute to this project, please follow these steps: |
| 13 | + |
| 14 | +1. **Fork** the repository by clicking on the "Fork" button on the top right corner of this page. |
| 15 | +2. **Clone** your fork of the repository to your local machine: |
| 16 | + |
| 17 | + ```bash |
| 18 | + git clone https://github.com/your-username/codeharborhub.git |
| 19 | + ``` |
| 20 | + |
| 21 | +3. **Create a new branch** for your changes: |
| 22 | + |
| 23 | + ```bash |
| 24 | + git checkout -b my-contribution |
| 25 | + ``` |
| 26 | + |
| 27 | +4. **Make your changes** and commit them to your branch: |
| 28 | + |
| 29 | + ```bash |
| 30 | + git commit -am "Add your commit message here" |
| 31 | + ``` |
| 32 | + |
| 33 | +5. **Push** your changes to your fork: |
| 34 | + |
| 35 | + ```bash |
| 36 | + git push origin my-contribution |
| 37 | + ``` |
| 38 | + |
| 39 | +6. Submit a **Pull Request** (PR) to the `main` branch of the original repository. Ensure that your PR includes a clear description of the changes you've made and any relevant information about your contribution. |
| 40 | +
|
| 41 | +## Code Style |
| 42 | +
|
| 43 | +Please adhere to the coding style guidelines used in this project. Consistent coding style helps make the codebase more maintainable and readable for everyone. |
| 44 | +
|
| 45 | +## Testing |
| 46 | +
|
| 47 | +Before submitting a PR, ensure that your changes pass any relevant tests. If you're adding new features or fixing bugs, consider adding tests to cover the changes you've made. |
| 48 | +
|
| 49 | +## Resources for Guidance |
| 50 | +
|
| 51 | +Here are some resources that may be helpful as you contribute to Code Harbor Hub: |
| 52 | +- [Docusaurus Documentation](https://docusaurus.io/docs/docs-introduction) |
| 53 | +- [React.js Documentation](https://legacy.reactjs.org/docs/getting-started.html) |
| 54 | +- [Markdown Guide](https://www.markdownguide.org/) |
| 55 | +- [MDX Documentation](https://mdxjs.com/docs/) |
| 56 | +- [Mermaid Documentation](https://mermaid.js.org/) |
| 57 | +
|
| 58 | +
|
| 59 | +## Questions or Need Help? |
| 60 | +
|
| 61 | +If you have any questions or need help with contributing to CodeHarborHub, please feel free to reach out to us through our [website](https://www.codeharborhub.live/) or by opening an [issue](https://github.com/CodeHarborHub/codeharborhub/issues) on GitHub. |
0 commit comments