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

Edit propose change #105

Merged
merged 11 commits into from
May 17, 2024
86 changes: 11 additions & 75 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,88 +7,24 @@ 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!

misspee007 marked this conversation as resolved.
Show resolved Hide resolved
# 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. 😸
## Adding or editing wiki pages locally
misspee007 marked this conversation as resolved.
Show resolved Hide resolved
Wikis are part of Git repositories, so you can make changes locally and push them to your repository using a Git workflow.

# 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.
### Cloning wikis to your computer
Every wiki provides an easy way to clone its contents down to your computer. Once you've created an initial page on GitHub, you can clone the repository to your computer with the provided URL:

## 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]
$ git clone https://github.com/chaoss/chaoss-slack-bot.wiki.git
# Clones the wiki locally
```
Once you have cloned the wiki, you can add new files, edit existing ones, and commit your changes. You and your collaborators can create branches when working on wikis, but only changes pushed to the default branch will be made live and available to your readers.

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">
## About wiki
The filename determines the title of your wiki page, and the file extension determines how your wiki content is rendered.

- You can also follow [this guide](https://www.secondstate.io/articles/dco/) for an alternative approach.
Wikis use our [open-source Markup library](https://github.com/github/markup) to convert the markup, and it determines which converter to use by a file's extension. For example, if you name a file foo.md or foo.markdown, wiki will use the Markdown converter, while a file named foo.textile will use the Textile converter.


## 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
```
Don't use the following characters in your wiki page's titles: ```\ / : * ? " < > |```. Users on certain operating systems won't be able to work with filenames containing these characters. Be sure to write your content using a markup language that matches the extension, or your content won't render properly.

# Community Resources
## CHAOSS
Expand Down
5 changes: 3 additions & 2 deletions Translations/Portuguese/Home.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
This is the link to the slack bot wiki homepage to be translated.
[Home](https://github.com/chaoss/chaoss-slack-bot/wiki)
# Bem-vindo ao wiki do chaoss-slack-bot 🎉
Chaoss Slack Bot é um aplicativo Slack que dá as boas-vindas aos recém-chegados à comunidade CHAOSS Slack. Ele foi construído usando a estrutura [Bolt para JavaScript](https://github.com/SlackAPI/bolt-js).
![CHAOSS Slack Bot](https://user-images.githubusercontent.com/71160347/203390508-12570ffb-65b8-445a-99d6-a9d142b8a916.png)
Loading