First off, thanks for taking the time to contribute!
The following is a set of guidelines for contributing to dscrait.tech, which is hosted in the dscrait.tech. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document by opening up an issue.
| Index | Content Heading |
|---|---|
| 1 | Code of Conduct |
| 2 | What should I know before I get started? |
| 3 | How Can I Contribute? |
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
By participating, you are expected to uphold this code. Please report unacceptable behavior to dsc.rait@gmail.com.
If chat is more your speed, you can join the DSC-RAIT Discord Channel:
- Join the DSC-RAIT Discord Channel
- Even though Discord is a chat service, sometimes it takes few hours for community members to respond — please be patient!
dscrait.tech is a open source project — it's made up of repositories. When you initially consider contributing to dscrait.tech, you might be unsure about which of those repositories implements the functionality you want to change or report a bug for. This section should help you with that.
1. Fork this repository.
2. Clone the forked repository.
git clone https://github.com/dscrait/dscrait.tech.git
3. Navigate to the project directory.
cd dscrait.tech
4. Install NPM packages.
npm install
5. Run the website in your localhost by typing this command.
npm run dev
6. Create a new Branch.
git branch <your_branch_name>
7. Switched to your new branch.
git checkout -b <your_branch_name>
8. Make changes locally.
git add filename.md
9. Before commiting your changes add the following commands on your terminal
git remote add upstream https://github.com/dscrait/dscrait.tech.git
git pull upstream master
10. Commit your changes.
git add .
git commit -m "<your_commit_message>"
# If so try to use conventional commit messages using the guide: https://www.conventionalcommits.org/en/v1.0.0/
11. Push your local branch to the remote repository.
git push origin
12. Create a Pull Request!
Unsure where to begin contributing to dscrait.tech? You can start by looking through these good first issues:
- Good First issues - issues which should only require a few lines of code, and a test or two.