Skip to content

Commit

Permalink
chore: Update CONTRIBUTING.md (#1341)
Browse files Browse the repository at this point in the history
  • Loading branch information
MantisClone authored Jan 24, 2024
1 parent 2a961fe commit 8720bd6
Showing 1 changed file with 27 additions and 16 deletions.
43 changes: 27 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@

We welcome contributions from anyone, and are grateful for even the smallest of fixes!

## Got a Question or Problem?
## Got a Question?

For quick help, join the [Request Discord](https://request.network/discord/) and ask your question there.
You will get a reply much faster than by opening an issue.
Please post questions on our [Github Discussions: Questions](https://github.com/orgs/RequestNetwork/discussions/categories/questions).
For quicker help, join the [Request Discord](https://request.network/discord/) and someone from the community may be able to help.

## Found a Bug?

If you have found a bug, please submit an issue to report it. Or even better, create a pull request!
If you found an issue or a bug, please create a Github Issue on the relevant repository. Or even better, create a pull request!

## Requesting a feature

You can request a new feature by submitting an issue to our GitHub Repository explaining the use case.
Request a new feature on our [Github Discussions: Feature Requests](https://github.com/orgs/RequestNetwork/discussions/categories/feature-requests) or by creating Github Issue on teh relevant repository.
If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it.

## Submission Guidelines

### Submitting an Issue

Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and
the discussion might inform you of workarounds readily available.
Before you submit an issue, please search the [Backlog](https://github.com/orgs/RequestNetwork/projects/3) to see if an issue already exists.
The discussion might inform you of workarounds readily available.

To ensure fast resolution, please include the useful details:

Expand All @@ -35,15 +35,26 @@ To ensure fast resolution, please include the useful details:

### Submitting a Pull Request (PR)

When contributing to this repository, please first discuss the change you wish to make via a github issue before making a change.
When contributing to this repository, please first discuss the change you wish to make via a Github Issue before making a change.

We have two main branches: `master` and `development`.
`master` represents the most recent released (published on npm) version.
`development` represents the development state and is a default branch to which you will submit a PR.
We use this structure so that we can push hotfixes to the currently released version without needing to publish all
the changes made towards the next release.
If a hotfix is implemented on `master`, it is back-ported to `development`.
We use trunk-based branch strategy: `master` branch represents the most recent released (published on npm) version.

### Useful information when developping
Internal contributors should create a branch from `master` and submit a PR to `master`.
External contributors should create a fork of the repository and submit a PR to `master`.

Have a look at this [guide](https://docs.request.network/dev/contributing) to help you get started with developing Request
Please name your PR with the following convention: `feat: <description>` or `fix: <description>` or `chore: <description>`.
The description should be a short summary of the changes in the PR.

Please include the following in your PR:

- A [magic link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) to the issue that it fixes (if there is one)
- A quick summary and/or background
- Explain why the change is necessary, important, or useful
- Explain the impact of the change
- Explain any limitations
- Explain any alternatives considered (if any)

Feel free to create a "Draft" PR as early as possible to get feedback on your work.
Then, when you are ready for review, mark it as "Ready for review" and request a review from one of the maintainers.

All PRs must pass the CI checks before being merged.

0 comments on commit 8720bd6

Please sign in to comment.