Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

51 lines (35 loc) · 3.24 KB
Raw

Contributing to Nada by Example

Thank you for considering contributing to the Nada by Example repository! Your contributions help improve the educational resources and example programs available to the community. This document provides guidelines and tips for contributing effectively.

Getting Started

1. Fork and Clone the Repository

  • Fork the Repository: Fork the repo on GitHub and clone your fork to your local machine.
  • Create a Branch: Always create a new branch for your work. Use a descriptive name (e.g., feature/new-example-name, bugfix/fix-issue-123).

2. Choose or Propose an Example

  • Choose an Existing Issue: Check the issues list for examples or problems that need solving.
  • Propose a New Example: If you have a new idea, open an issue to discuss it before you start coding.

3. Develop Your Example

  • Follow the Guidelines: Ensure your example follows the coding standards and practices described below.
  • Document Your Code: Provide clear comments and documentation within your code to help others understand your example.
  • Test Your Example: Make sure your example works as expected and does not break existing examples.

Pull Request Process

1. Create a Pull Request

  • Title and Description: Provide a clear title and detailed description of the example or issue you're addressing.
  • Link to Issues: If your pull request addresses an issue, link to it in the description (e.g., Closes #123).

2. Complete the PR Template

When creating a pull request, use the provided PR template:

  • Description: Clearly describe the example you are adding. Explain what it does, its purpose, and who it benefits.
  • Additional Information: Confirm that you've read the contributing docs and that your PR is not a duplicate.
  • Related Issues: Link any related issues that your PR addresses.
  • Optional Contributor POAP: (Proof of Attendance Protocol) If you want to receive a contributor POAP, provide your Twitter handle and Ethereum address.

3. Request a Review

  • Assign Reviewers: Request a review from one or more project maintainers. They will provide feedback and merge your PR if everything looks good.

Code Style and Standards

  • Consistency: Follow the existing coding style in the repository. Keep your code clean and organized.
  • Comments and Documentation: Include comments that explain the purpose and functionality of your code. If your example is complex, provide a detailed explanation in the description or a separate documentation file.
  • Naming Conventions: Use descriptive and meaningful names for variables, functions, and files.
  • Test Cases: If applicable, include test cases or examples that demonstrate how your code works.

Community and Support

  • Join the Discussion: If you need help or want to discuss ideas, feel free to join the discussions on our Github Discussions page.
  • Be Respectful: Treat others with respect and kindness. We strive to maintain a welcoming and inclusive community.

License

By contributing to this repository, you agree that your contributions will be licensed under the project's LICENSE.