Skip to content

Commit

Permalink
doc: contributing.md changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Nishchit14 committed Aug 23, 2023
1 parent 90adb41 commit dade5bb
Showing 1 changed file with 48 additions and 15 deletions.
63 changes: 48 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,50 @@
# Contributing Guidelines for firecamp.io
# Contributing to firecamp.dev

Thank you for showing an interest in contributing to firecamp.dev! All kinds of contributions are valuable to us. Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

In this guide, we will cover how you can quickly onboard and make your first contribution.

> Before jumping into a PR be sure to search [existing PRs](https://github.com/firecamp-dev/firecamp/pulls) or [issues](https://github.com/firecamp-dev/firecamp/issues) for an open or closed item that relates to your submission.
## Developing
The development branch is main. This is the branch that all pull requests should be made against. The changes on the main branch are tagged into a release periodically.

To develop locally:

1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
2. Create a new branch:
`git checkout -b feat/MY_BRANCH_NAME`
3. Set up your `.env` file:
- Duplicate .env.example to .env.
`cp .env.example .env`
4. Install pnpm:
`npm install -g pnpm` or [via brew, curl or wget](https://pnpm.io/installation)
5. Start developing and watch for code changes:
`pnpm dev`

### Pull Request Workflow

1. Create a new branch for your changes. Use a descriptive and meaningful name for the branch that reflects the purpose of your contribution.
2. Make your changes in the branch, following the project's coding style and guidelines.
3. Commit your changes with appropriate messages, adhering to the commit guidelines mentioned above.
4. Push your branch to your forked repository.
5. Create a pull request (PR) from your branch to the main firecamp.dev repository.
6. Provide a clear and concise title for your pull request, summarizing the changes made.
7. In the PR description, provide a brief explanation of the problem you solved or the feature you added. If applicable, include relevant screenshots or a video showcasing the changes and link the issue id.
8. Tag your PR with one or more relevant labels from the following options: `graphql`, `ui`, `documentation`, `rest`, `backend`, or any other appropriate labels.



## Building
More info on how to build app coming soon.

## Testing
More info on how to add new tests coming soon.

## Linting
More info on how to lint coming soon.


Thank you for considering contributing to firecamp.io! To ensure smooth collaboration and maintain a consistent workflow, please follow the guidelines below.

## Commit Guidelines

Expand All @@ -25,17 +69,6 @@ feat(auth): Add new authentication module
```

## Fork and Pull Request Workflow

1. Fork the firecamp.io repository to your GitHub account.
2. Create a new branch for your changes. Use a descriptive and meaningful name for the branch that reflects the purpose of your contribution.
3. Make your changes in the branch, following the project's coding style and guidelines.
4. Commit your changes with appropriate messages, adhering to the commit guidelines mentioned above.
5. Push your branch to your forked repository.
6. Create a pull request (PR) from your branch to the main firecamp.io repository.
7. Provide a clear and concise title for your pull request, summarizing the changes made.
8. In the PR description, provide a brief explanation of the problem you solved or the feature you added. If applicable, include relevant screenshots or a video showcasing the changes and link the issue id.
9. Tag your PR with one or more relevant labels from the following options: `graphql`, `ui`, `documentation`, `rest`, `backend`, or any other appropriate labels.


## Issue Creation
Expand All @@ -50,9 +83,9 @@ feat(auth): Add new authentication module
## General Community Guidelines

1. Be respectful and considerate when interacting with other community members.
2. Follow the code of conduct specified by firecamp.io. Treat others with kindness, empathy, and professionalism.
2. Follow the code of conduct specified by firecamp.dev. Treat others with kindness, empathy, and professionalism.
3. Provide constructive feedback and suggestions, helping to improve the project.
4. Engage in discussions and contribute positively to the community.
5. Keep communication clear and concise, using appropriate channels such as GitHub issues or designated forums.

By following these guidelines, you'll contribute effectively to firecamp.io and help build a vibrant and collaborative open-source community. Thank you for your contributions!
By following these guidelines, you'll contribute effectively to firecamp.dev and help build a vibrant and collaborative open-source community. Thank you for your contributions!

0 comments on commit dade5bb

Please sign in to comment.