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.

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

Add Contributing Guidelines #439

Merged
merged 3 commits into from
Apr 12, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing Guidelines

Thank you for considering contributing to our project! We welcome contributions from everyone and appreciate your interest in making our project better.

## Sign off Your Work

The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the [DCO](http://developercertificate.org/). Contributors must sign-off that they adhere to these requirements by adding a `Signed-off-by` line to commit messages.

```text
This is my commit message

Signed-off-by: John Doe <john.doe@fablo.com>
```

See `git help commit`:

```text
-s, --signoff
Add Signed-off-by line by the committer at the end of the commit log
message. The meaning of a signoff depends on the project, but it typically
certifies that committer has the rights to submit this work under the same
license and agrees to a Developer Certificate of Origin (see
http://developercertificate.org/ for more information).
```

## Getting Started

1. **Fork the repository**: Click the "Fork" button at the top right corner of the repository's page on GitHub.
2. **Clone your fork**: Use `git clone` to clone the repository to your local machine.
3. **Set up remote upstream**: Add the original repository as a remote named "upstream" using `git remote add upstream [original repository URL]`.
4. **Create a new branch**: Use `git checkout -b [branch-name]` to create a new branch for your contribution.

## Making Changes

1. **Make your changes**: Implement the changes or additions you want to make. Please follow any coding standards and guidelines provided in the project.
2. **Test your changes**: Ensure that your changes work as expected and don't introduce any new issues. Run the following tests:
sroopsai marked this conversation as resolved.
Show resolved Hide resolved
- **End-to-End (E2E) tests**: Execute E2E tests using the provided scripts. You can run E2E tests with `npm run test:e2e`. Make sure they pass before submitting your changes.
- **Regular integration tests**: Run regular integration tests to validate the functionality. You can run integration tests with `npm run test:integration`.
sroopsai marked this conversation as resolved.
Show resolved Hide resolved
3. **Update snapshots**: If you've made changes that affect snapshots, update them using `npm run test:e2e-update`.
sroopsai marked this conversation as resolved.
Show resolved Hide resolved

## Submitting Changes
sroopsai marked this conversation as resolved.
Show resolved Hide resolved

1. **Push your changes**: Once you've made and tested your changes, push them to your forked repository with `git push origin [branch-name]`.
2. **Create a pull request**: Go to the original repository on GitHub and create a pull request from your forked branch to the main branch.
3. **Provide details**: Give your pull request a descriptive title and provide details about the changes you've made.
4. **Review process**: Your pull request will be reviewed by maintainers. Be responsive to any feedback and make necessary changes.

We appreciate your contributions and look forward to working with you!

5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -579,6 +579,11 @@ Visit the [Fablo REST](https://github.com/softwaremill/fablo-rest) project for m
Fablo can run [Blockchain Explorer](https://github.com/hyperledger/blockchain-explorer) for you.
Provide for your organization `"tools": { "explorer": true }`, if you want to use it per organization, or provide the same value in `global` section of the config, if you want to use one global Explorer for all organizations.

## Contributing

We'd love to have you contribute! Please refer to our [contribution guidelines](https://github.com/hyperledger-labs/fablo/blob/main/CONTRIBUTING.md) for details.


## Testimonials

Fablo was originally created at [SoftwareMill](https://softwaremill.com) by [@Hejwo](https://github.com/Hejwo/) and [@dzikowski](https://github.com/dzikowski/).
Expand Down
Loading