Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 4.29 KB

CONTRIBUTING.md

File metadata and controls

67 lines (43 loc) · 4.29 KB

Yonode Contributing Guide

Welcome, and thank you for your interest in contributing to Yonode! This guide aims to provide you with all the information you need to contribute to the project effectively. Whether you're fixing a bug, adding a new feature, or improving documentation, your contributions are highly appreciated.

Code of Conduct

Before contributing, please read our Code of Conduct. By participating in this project, you agree to abide by its terms.

How to Contribute

Contributions to Yonode can take various forms. Below are the ways you can contribute to the project's success:

  • Code Submissions: Enhancements, bug fixes, or new features.
  • Documentation: Updates, improvements, or corrections to our documentation.
  • Bug Reports: Identifying and reporting issues for improvement.
  • Feature Requests: Suggestions for new features or enhancements.
  • Code Reviews: Participating in code reviews to ensure quality and consistency.

Getting Started

  • Explore the Project: Familiarize yourself with Yonode by reading the documentation, exploring the codebase, and understanding the project's goals.
  • Read the Documentation: Familiarize yourself with the project documentation. Understanding the project's architecture and philosophy is crucial for making meaningful contributions.
  • Find an Issue: Look through the GitHub Issues for tasks. If you're new, look for issues tagged with "good first issue" or "help wanted."
  • Discussion: For new features or significant changes, it's best to open a discussion or issue first. This allows the community to give feedback early and align efforts.

Making Changes

  • Create a New Branch: For every new feature or bug fix, Create a branch for your contributions. For new features, use feature/your-feature-name; for bug fixes, bugfix/issue-title.
  • Write Meaningful Commit Messages: Your commit messages should clearly describe what changes have been made and why.
  • Write Tests: If you're adding a new feature or fixing a bug, please include tests that cover your changes.
  • Follow the Style Guide: Ensure your code follows the established style guidelines.

Submitting a Pull Request

  • Rebase Your Branch: Ensure your branch is up to date with the main branch.
  • Open a Pull Request: Once your changes are ready, open a pull request against the main branch. Provide a clear description of the problem you're solving and any relevant issue numbers.
  • Review Process: The core team will review your pull request. Be open to feedback and willing to make changes if requested.

Review Process

  • Code Review: Your PR will be reviewed by the maintainers or other contributors. Be open to feedback and willing to make adjustments. The review process is a time for discussion and improvement.
  • Testing: In addition to automated tests, your changes may be manually tested to ensure they work as expected and don't introduce any new issues.
  • Merging: Once your PR has been approved and passes all tests, it will be merged into the main branch. Congratulations, and thank you for your contribution!

Reporting Bugs

  • Use GitHub Issues: Report bugs using GitHub Issues. Before creating a new issue, please check if the bug has already been reported.
  • Provide Detailed Information: When reporting a bug, include as much information as possible, such as the Node.js version, platform, and steps to reproduce the bug.

Request for Comments (RFCs)

For substantial changes, we use an RFC process. If you propose a major change, start by opening an issue to discuss your proposal. This allows the community to discuss and refine ideas before you invest significant effort into it.

License

By contributing to Yonode, you agree that your contributions will be licensed under the project's license.

Community Conduct

  • Be Respectful: Treat everyone with respect. We're building a welcoming and supportive community.
  • Collaborate: Be open to collaboration. Yonode is a community project, and teamwork makes it better for everyone.
  • Stay Positive: Approach every interaction positively and constructively. We're all here to learn and grow.

Need Help?

If you're unsure about anything or have questions, don't hesitate to ask. You can open an issue for questions or reach out to the maintainers directly.