Skip to content

Commit

Permalink
update and propose changes in contributing file
Browse files Browse the repository at this point in the history
  • Loading branch information
@ElisaCapololo
ElisaCapololo committed Apr 17, 2024
1 parent 6e2cae1 commit 7730cb2
Showing 1 changed file with 0 additions and 111 deletions.
111 changes: 0 additions & 111 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,117 +7,6 @@ CHAOSS Slack Bot is an open source project and we love to receive contributions

We follow the standard Git workflow of fork -> change -> pull request -> merge -> update fork -> change ... (repeat forever). If you are new to open source, we recommend GitHub's excellent guide on "How to Contribute to Open Source". In addition, please feel free to reach out to any of the maintainers or other community members if you are struggling; we are here to help you learn!

# Your First Contribution
**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://kcd.im/pull-request).
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first. 😸

# Getting Started
## Opening an issue
If you're experiencing an issue with CHAOSS Slack Bot or have a question you'd like help answering, please feel free to open an issue. To help us prevent duplicates, we kindly ask that you briefly search for your problem or question in our issues before opening a new one.
Please note that if you open a bug report, we cannot help you until you have provided us with all the relevant information. Respectfully, we do not have the time to try and recreate an error given with minimal or no context, so by providing this information you are helping us help you! Provide descriptions to the best of your ability, and please include screenshots and error logs if applicable.

## Fixing an issue
If you would like to fix an existing issue, leave a comment on it to indicate. This is to avoid having several people unknowingly working on the same issue.

## Contributing to the source code
1. Fork this repo, and then clone it
```
$ git clone https://github.com/chaoss/chaoss-slack-bot.git
$ cd chaoss-slack-bot
$ git remote add upstream https://github.com/chaoss/chaoss-slack-bot.git
```

2. Follow the [development setup instructions](https://github.com/chaoss/chaoss-slack-bot/blob/main/SETUP.md)

3. Install dependencies ```$ npm install``` or ```$ yarn add```

4. Create a new branch

```$ git checkout -b my-new-branch```

5. Make your change(s). We encourage you to write tests.

6. Commit the change(s) with a descriptive commit message and push to your fork. PS: here's a guide for [writing good commit messages](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/). if you’re not familiar with DCO, read the guide on [signing off commits](#signing-off-on-commits) before you come back to this step.
```
$ git add .
$ git commit -s -m "descriptive commit message"
$ git push -u origin my-new-branch
```

7. Submit a pull request.

At this point, you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day). Once one of our maintainers has had a chance to review your PR, we will either mark it as "needs review" and provide specific feedback on your changes, or we will go ahead and complete the pull request.

## Signing-off on Commits
To contribute to this project, you must agree to the Developer Certificate of Origin by the CHAOSS charter for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution. To signify that you agree to the DCO for contributions, you simply add a line to each of your git commit messages:
Signed-off-by: Jane Smith <[email protected]>

This can be easily done by using the -s flag when using git commit. For example:
$ git commit -s -m "my commit message w/signoff"

To ensure all your commits are signed, you have to configure git properly by editing your global .gitconfig
```
$ git config --global user.name "John Doe"
$ git config --global user.email [email protected]
```

Any pull requests containing commits that are not signed off will not be eligible for merge until the commits have been signed off.

### How to Fix a Failed DCO Check
Sometimes, you might forget to sign off your commits. We understand, but your pull request will fail the DCO check, and we will not be able to merge it. If this happens, here is how you can fix it:

- To fix a failed DCO check, go to the pull request page and scroll down to the section that shows the successful and failed checks. It is located just above the new comment text area.

<img width="1437" alt="Screenshot 2023-10-10 at 1 31 32 PM" src="https://github.com/chaoss/chaoss-slack-bot/assets/71160347/c8dab20a-e6e9-4b17-82ab-4f54f9c7d42c">

- Click on the DCO details, and follow the instructions to fix the problem.

<img width="1437" alt="Screenshot 2023-10-10 at 1 33 43 PM" src="https://github.com/chaoss/chaoss-slack-bot/assets/71160347/d6c04196-e686-42bd-be77-62bff80ce895">

- You can also follow [this guide](https://www.secondstate.io/articles/dco/) for an alternative approach.


## Keeping in sync with the Chaoss Slack Bot Repository
Remember to sync your fork with the main branch regularly. To do this:
Make sure to be in the root folder of the project and the branch should be master branch and type
```
$ git remote add upstream https://github.com/chaoss/chaoss-slack-bot.git
```

Now you have your upstream setup in your local machine,whenever you need to make a new branch for making changes make sure your main branch is in sync with the main repository, to do this,make sure to be in the main branch and type:
```
$ git pull upstream master
$ git push origin master
```

# Contributing to the wiki
## Adding or editing wiki pages

You can add and edit wiki pages directly on GitHub or locally using the command line.

Wikis are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see [GitHub’s plans.](https://docs.github.com/en/get-started/learning-about-github/githubs-plans)

## Adding wiki pages
1. On GitHub.com, navigate to the main page of the repository.
2. Under your repository name, click **Wiki**.
![wiki](https://docs.github.com/assets/cb-50195/mw-1440/images/help/wiki/wiki-menu-link.webp)
3. In the upper-right corner of the wiki, click **New Page**.
4. Optionally, to write in a format other than Markdown, use the "Edit mode" dropdown to choose a different format.
![Edit mode](https://docs.github.com/assets/cb-109300/mw-1440/images/help/wiki/wiki-edit-mode-dropdown.webp)
5. Use the text editor to add your page's content.
6. In the "Edit message" field, type a commit message describing the new file you’re adding.
7. To commit your changes to the wiki, click Save Page.

## Editing wiki pages
1. On GitHub.com, navigate to the main page of the repository.
2. Under your repository name, click **Wiki**.
![wiki](https://docs.github.com/assets/cb-50195/mw-1440/images/help/wiki/wiki-menu-link.webp)
3. Using the wiki sidebar on the right, navigate to the page you want to change. In the upper-right corner of the page, click **Edit**.
4. Use the text editor to edit the page's content.
5. In the "Edit message" field, type a commit message describing the new file you’re adding.
6. To commit your changes to the wiki, click **Save Page**.


## Adding or editing wiki pages locally
Wikis are part of Git repositories, so you can make changes locally and push them to your repository using a Git workflow.

Expand Down

0 comments on commit 7730cb2

Please sign in to comment.