Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: link to how to add a new example in the contributing guide #32

Closed
wants to merge 1 commit into from
Closed

chore: link to how to add a new example in the contributing guide #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,30 @@ Thank you for considering contributing to the Nada by Example repository! Your c
## 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](https://github.com/NillionNetwork/nada-by-example/issues) 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.

- **Add a new example** Follow README instructions on how to [add a new example](https://github.com/NillionNetwork/nada-by-example?tab=readme-ov-file#add-a-new-example) including at least one test file.
- **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.
- **Test Your Example:** Make sure all tests pass using `nada test`.

## 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.
Expand All @@ -32,6 +37,7 @@ When creating a pull request, use the provided PR template:
- **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
Expand Down
Loading