INTECS Open Source - Contribution Guidelines
Types of contributions we're looking for :-
People with enthusiasm to contribute to open source projects to gain knowledge and experience are welcome. (Read the “How to Contribute” section thoroughly before joining the project and post any inquiries regarding the above in the gitter community). Also please go through code of conduct section as well.
Join Gitter Community
Expectations :-
Before we get started, here are a few things we expect from you (and that you should expect from others):
-
Be kind and thoughtful in your conversations related to the project. We all come from different backgrounds and projects, hence we are likely to have different perspectives on "how open source is done." So, be respectful of different viewpoints.
-
Open Source Code of conduct is published here . You must go through this before participating.
-
By participating in this project, you agree to all the terms mentioned in this document.
-
Once you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you will need to address them before your contribution is merged.
How to contribute :-
If you would like to contribute, start by searching through the issues. After picking one, please check whether someone else has already started working on the issue. If you get interested. Please follow the succeeding steps to make your contribution
- Join the gitter community which is mentioned in the project.
- Add a comment on the selected issue to reserve it for yourself.
- To know further details regarding a certain issue, you are facilitated to discuss with the mentor who is assigned to that issue through the slack channel.
- Fork the project to your personal account.
- Checkout to the “dev” branch.
- The issue ID should be mentioned in the commit message.
- When you complete a task and wish to male a pull request, make sure to mention any special comments in the pull request itself.
Rules :-
-
If the participant who commented to reserve the issue does not update anything about the tasks within 3 days time on the slack channel or GitHub, the mentor of the particular project has the sole right to open the issue for the others by commenting on that issue.
-
The mentor of a particular issue is possessing the sole right of accepting or rejecting a pull request.
Style Guide :-
This project was bootstrapped with Create React App.
- Use Bootstrap 4.
- If you use any third party libraries for component styles please get approvel from project mentors at community chat.
- Use the common classes available in the main style sheet as much as possible.
- If there are CSS which are unique to your task, please add them to the CSS file.
- Take a screenshot of the final appearance of your task and post it on the community forum to get the approval from the mentor before putting a pull request.
Available Scripts :-
In the project directory, you can run:
npm install
Install all the dependencies for the project. See the section about install a package for more information.
npm start
Runs the app in the development mode. Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.
npm test
Launches the test runner in the interactive watch mode. See the section about running tests for more information.
npm run build
Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.
Learn More ..
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
INTECS Open Source - Contributor’s Code of Conduct
Our Pledge :
As Contributors and maintainers of INTECS Open Source project, we pledge to make participation in our project a harassment-free, open experience for each and every one of you regardless of seniority, physical disabilities and physical appearance, ethnicity, gender, level of expression, nationality and religion.
Vision :
To inspire young individuals in programming while motivating them to actively contribute to open source projects and gain exposure to the open-source community and ethics.
Our Standards :
INTECS Opensource is open for all the undergraduates of the Faculty of Information Technology, University of Moratuwa. All the participants should adhere to professional conduct and contribute to creating a positive environment. Examples for such behaviour include:
- Use professional and formal speech.
- 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.
- Be responsible for the task undertaken.
Examples of unacceptable behaviour by participants include:
- Trolling, insulting/derogatory comments, and personal or political attacks.
- Abusive or insulting comments between undergraduates or between batches.
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Scope of code of conduct :
This Code of Conduct extends both inside project spaces as well as in public spaces in which a person serves the project or the community.
Enforcement
Instances of abusive, harassing, or otherwise, unacceptable behaviour may be reported by contact INTECS by mail here , which is a shared team inbox. If the incident involves someone who receives that shared inbox, you can also contact an individual maintainer.
Project contributors who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by the organizers.